diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index ef394487d..4a987fcf7 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -6853,6 +6853,60 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot users usage metrics for a specific day", @@ -23037,7 +23091,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -23126,7 +23180,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -23297,7 +23351,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23351,7 +23405,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -23530,7 +23584,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23574,7 +23628,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23712,7 +23766,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23881,7 +23935,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24051,7 +24105,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24117,7 +24171,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24207,7 +24261,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -24363,7 +24417,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24436,7 +24490,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -24539,7 +24593,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -25925,6 +25979,63 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -54807,6 +54918,15 @@ }, "403": { "$ref": "#/components/responses/dependency_review_forbidden" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" } }, "x-github": { @@ -60558,6 +60678,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/labels" }, @@ -67669,94 +67798,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/pull-number" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/pull-number" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -74657,7 +74698,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -118696,7 +118738,7 @@ }, "issue-type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -132222,128 +132264,6 @@ } } }, - "repository-rule-file-path-restriction": { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - "repository-rule-max-file-path-length": { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - "repository-rule-file-extension-restriction": { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - "repository-rule-max-file-size": { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, "repository-rule-params-restricted-commits": { "title": "RestrictedCommits", "description": "Restricted commit", @@ -132521,6 +132441,128 @@ } } }, + "repository-rule-file-path-restriction": { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + "repository-rule-max-file-path-length": { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + "repository-rule-file-extension-restriction": { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + "repository-rule-max-file-size": { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -132572,25 +132614,25 @@ "$ref": "#/components/schemas/repository-rule-tag-name-pattern" }, { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + "$ref": "#/components/schemas/repository-rule-workflows" }, { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + "$ref": "#/components/schemas/repository-rule-code-scanning" }, { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-copilot-code-review" }, { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + "$ref": "#/components/schemas/repository-rule-max-file-size" } ] }, @@ -149732,7 +149774,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + "$ref": "#/components/schemas/repository-rule-workflows" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149742,7 +149784,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + "$ref": "#/components/schemas/repository-rule-code-scanning" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149752,7 +149794,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-copilot-code-review" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149762,7 +149804,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149772,7 +149814,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149782,7 +149824,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149792,7 +149834,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + "$ref": "#/components/schemas/repository-rule-max-file-size" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -332478,6 +332520,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index f10074d9c..ec1d5a616 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -5177,6 +5177,47 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot enterprise user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day @@ -17031,6 +17072,8 @@ paths: Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response. tags: - copilot-spaces operationId: copilot-spaces/list-for-org @@ -17096,6 +17139,8 @@ paths: Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources. tags: - copilot-spaces operationId: copilot-spaces/create-for-org @@ -17224,6 +17269,8 @@ paths: Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-for-org @@ -17264,6 +17311,8 @@ paths: Organization members with appropriate permissions can update Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated. tags: - copilot-spaces operationId: copilot-spaces/update-for-org @@ -17401,6 +17450,8 @@ paths: Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-for-org @@ -17437,6 +17488,8 @@ paths: **Note:** Team collaborators listed here are teams that are defined in the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-collaborators-for-org @@ -17551,6 +17604,8 @@ paths: When adding teams as collaborators, they must be defined in the organization. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/add-collaborator-for-org @@ -17684,6 +17739,8 @@ paths: Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/update-collaborator-for-org @@ -17818,6 +17875,8 @@ paths: Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/remove-collaborator-for-org @@ -17867,6 +17926,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-resources-for-org @@ -17935,6 +17996,8 @@ paths: For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created. tags: - copilot-spaces operationId: copilot-spaces/create-resource-for-org @@ -18045,6 +18108,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-resource-for-org @@ -18098,6 +18163,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated. tags: - copilot-spaces operationId: copilot-spaces/update-resource-for-org @@ -18170,6 +18237,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-resource-for-org @@ -19276,6 +19345,51 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot organization user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '204': + "$ref": "#/components/responses/no_content" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot organization users usage metrics for a specific day @@ -40314,6 +40428,12 @@ paths: "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/dependency_review_forbidden" + '400': + "$ref": "#/components/responses/bad_request" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false category: dependency-graph @@ -44594,6 +44714,20 @@ paths: required: false schema: type: string + - name: issue_field_values + description: |- + A comma-separated list of issue field filters in `field_slug:value` format. + Only issues matching all specified field values are returned. + Requires issue fields to be enabled for the repository. Issue fields are + not available for user-owned repositories, and field availability for + organization-owned public repositories depends on the organization's + visibility settings. For example, `priority:Urgent,severity:High` filters + issues where the `priority` field is `Urgent` AND the `severity` field is + `High`. + in: query + required: false + schema: + type: string - "$ref": "#/components/parameters/labels" - name: sort description: What to sort results by. @@ -49565,67 +49699,6 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": - put: - summary: Archive a pull request - description: |- - Archives a pull request. Closes, locks, and marks the pull request as archived. - Only repository admins can archive pull requests. - Archived pull requests are hidden from non-admin users. - tags: - - pulls - operationId: pulls/archive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/pull-number" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - delete: - summary: Unarchive a pull request - description: |- - Unarchives a pull request. Removes the archived flag from the pull request. - Does not automatically reopen or unlock the pull request. - Only repository admins can unarchive pull requests. - tags: - - pulls - operationId: pulls/unarchive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/pull-number" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -54560,6 +54633,7 @@ paths: - no_accessible_repos - server_error - only_non_semantic_fields_requested + - service_unavailable examples: default: "$ref": "#/components/examples/issue-search-result-item-paginated" @@ -86352,7 +86426,8 @@ components: - updated_at issue-type: title: Issue Type - description: The type of issue. + description: The type assigned to the issue. This is only present for issues + in repositories where issue types are supported. type: - object - 'null' @@ -96442,98 +96517,6 @@ components: required: - operator - pattern - repository-rule-file-path-restriction: - title: file_path_restriction - description: Prevent commits that include changes in specified file and folder - paths from being pushed to the commit graph. This includes absolute paths - that contain file names. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted from being pushed to - the commit graph. - items: - type: string - required: - - restricted_file_paths - repository-rule-max-file-path-length: - title: max_file_path_length - description: Prevent commits that include file paths that exceed the specified - character limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed in file paths. - minimum: 1 - maximum: 32767 - required: - - max_file_path_length - repository-rule-file-extension-restriction: - title: file_extension_restriction - description: Prevent commits that include files with specified file extensions - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_extensions - repository-rule-max-file-size: - title: max_file_size - description: Prevent commits with individual files that exceed the specified - limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. This limit - does not apply to Git Large File Storage (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size repository-rule-params-restricted-commits: title: RestrictedCommits description: Restricted commit @@ -96675,6 +96658,98 @@ components: type: boolean description: Copilot automatically reviews each new push to the pull request. + repository-rule-file-path-restriction: + title: file_path_restriction + description: Prevent commits that include changes in specified file and folder + paths from being pushed to the commit graph. This includes absolute paths + that contain file names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed to + the commit graph. + items: + type: string + required: + - restricted_file_paths + repository-rule-max-file-path-length: + title: max_file_path_length + description: Prevent commits that include file paths that exceed the specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + repository-rule-file-extension-restriction: + title: file_extension_restriction + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + repository-rule-max-file-size: + title: max_file_size + description: Prevent commits with individual files that exceed the specified + limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size repository-rule: title: Repository Rule type: object @@ -96695,13 +96770,13 @@ components: - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-size" - - "$ref": "#/components/schemas/repository-rule-workflows" - - "$ref": "#/components/schemas/repository-rule-code-scanning" - - "$ref": "#/components/schemas/repository-rule-copilot-code-review" repository-ruleset: title: Repository ruleset type: object @@ -108968,25 +109043,25 @@ components: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-code-scanning" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-max-file-size" + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object @@ -248050,6 +248125,15 @@ components: node_id: MDU6SXNzdWUzNTgwMg== number: 132 title: Line Number Indexes Beyond 20 Not Displayed + type: + id: 1 + node_id: IT_kwDNJr9H + name: Bug + description: An unexpected problem or behavior + color: red + created_at: '2023-10-09T13:30:49Z' + updated_at: '2024-05-30T18:20:53Z' + is_enabled: true user: login: Nick3C id: 90254 diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index ee668f07e..5ab3a21d4 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -6853,6 +6853,60 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot users usage metrics for a specific day", @@ -22995,7 +23049,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -23084,7 +23138,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -23255,7 +23309,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23309,7 +23363,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -23488,7 +23542,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23532,7 +23586,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23670,7 +23724,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23839,7 +23893,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24009,7 +24063,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24075,7 +24129,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24165,7 +24219,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -24321,7 +24375,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24394,7 +24448,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -24497,7 +24551,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -25883,6 +25937,63 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -54732,6 +54843,15 @@ }, "403": { "$ref": "#/components/responses/dependency_review_forbidden" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" } }, "x-github": { @@ -60483,6 +60603,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/labels" }, @@ -67580,94 +67709,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/pull-number" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/pull-number" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -74568,7 +74609,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -118488,7 +118530,7 @@ }, "issue-type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -131625,128 +131667,6 @@ } } }, - "repository-rule-file-path-restriction": { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - "repository-rule-max-file-path-length": { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - "repository-rule-file-extension-restriction": { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - "repository-rule-max-file-size": { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, "repository-rule-params-restricted-commits": { "title": "RestrictedCommits", "description": "Restricted commit", @@ -131924,6 +131844,128 @@ } } }, + "repository-rule-file-path-restriction": { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + "repository-rule-max-file-path-length": { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + "repository-rule-file-extension-restriction": { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + "repository-rule-max-file-size": { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -131975,25 +132017,25 @@ "$ref": "#/components/schemas/repository-rule-tag-name-pattern" }, { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + "$ref": "#/components/schemas/repository-rule-workflows" }, { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + "$ref": "#/components/schemas/repository-rule-code-scanning" }, { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-copilot-code-review" }, { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + "$ref": "#/components/schemas/repository-rule-max-file-size" } ] }, @@ -149069,7 +149111,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + "$ref": "#/components/schemas/repository-rule-workflows" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149079,7 +149121,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + "$ref": "#/components/schemas/repository-rule-code-scanning" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149089,7 +149131,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-copilot-code-review" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149099,7 +149141,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149109,7 +149151,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149119,7 +149161,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -149129,7 +149171,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + "$ref": "#/components/schemas/repository-rule-max-file-size" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -331540,6 +331582,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index a34776155..9dd21eb59 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -5177,6 +5177,47 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot enterprise user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day @@ -16997,6 +17038,8 @@ paths: Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response. tags: - copilot-spaces operationId: copilot-spaces/list-for-org @@ -17062,6 +17105,8 @@ paths: Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources. tags: - copilot-spaces operationId: copilot-spaces/create-for-org @@ -17190,6 +17235,8 @@ paths: Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-for-org @@ -17230,6 +17277,8 @@ paths: Organization members with appropriate permissions can update Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated. tags: - copilot-spaces operationId: copilot-spaces/update-for-org @@ -17367,6 +17416,8 @@ paths: Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-for-org @@ -17403,6 +17454,8 @@ paths: **Note:** Team collaborators listed here are teams that are defined in the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-collaborators-for-org @@ -17517,6 +17570,8 @@ paths: When adding teams as collaborators, they must be defined in the organization. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/add-collaborator-for-org @@ -17650,6 +17705,8 @@ paths: Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/update-collaborator-for-org @@ -17784,6 +17841,8 @@ paths: Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/remove-collaborator-for-org @@ -17833,6 +17892,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-resources-for-org @@ -17901,6 +17962,8 @@ paths: For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created. tags: - copilot-spaces operationId: copilot-spaces/create-resource-for-org @@ -18011,6 +18074,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-resource-for-org @@ -18064,6 +18129,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated. tags: - copilot-spaces operationId: copilot-spaces/update-resource-for-org @@ -18136,6 +18203,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-resource-for-org @@ -19242,6 +19311,51 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot organization user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '204': + "$ref": "#/components/responses/no_content" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot organization users usage metrics for a specific day @@ -40253,6 +40367,12 @@ paths: "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/dependency_review_forbidden" + '400': + "$ref": "#/components/responses/bad_request" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false category: dependency-graph @@ -44533,6 +44653,20 @@ paths: required: false schema: type: string + - name: issue_field_values + description: |- + A comma-separated list of issue field filters in `field_slug:value` format. + Only issues matching all specified field values are returned. + Requires issue fields to be enabled for the repository. Issue fields are + not available for user-owned repositories, and field availability for + organization-owned public repositories depends on the organization's + visibility settings. For example, `priority:Urgent,severity:High` filters + issues where the `priority` field is `Urgent` AND the `severity` field is + `High`. + in: query + required: false + schema: + type: string - "$ref": "#/components/parameters/labels" - name: sort description: What to sort results by. @@ -49490,67 +49624,6 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": - put: - summary: Archive a pull request - description: |- - Archives a pull request. Closes, locks, and marks the pull request as archived. - Only repository admins can archive pull requests. - Archived pull requests are hidden from non-admin users. - tags: - - pulls - operationId: pulls/archive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/pull-number" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - delete: - summary: Unarchive a pull request - description: |- - Unarchives a pull request. Removes the archived flag from the pull request. - Does not automatically reopen or unlock the pull request. - Only repository admins can unarchive pull requests. - tags: - - pulls - operationId: pulls/unarchive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/pull-number" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -54485,6 +54558,7 @@ paths: - no_accessible_repos - server_error - only_non_semantic_fields_requested + - service_unavailable examples: default: "$ref": "#/components/examples/issue-search-result-item-paginated" @@ -86181,7 +86255,8 @@ components: - updated_at issue-type: title: Issue Type - description: The type of issue. + description: The type assigned to the issue. This is only present for issues + in repositories where issue types are supported. type: - object - 'null' @@ -96003,98 +96078,6 @@ components: required: - operator - pattern - repository-rule-file-path-restriction: - title: file_path_restriction - description: Prevent commits that include changes in specified file and folder - paths from being pushed to the commit graph. This includes absolute paths - that contain file names. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted from being pushed to - the commit graph. - items: - type: string - required: - - restricted_file_paths - repository-rule-max-file-path-length: - title: max_file_path_length - description: Prevent commits that include file paths that exceed the specified - character limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed in file paths. - minimum: 1 - maximum: 32767 - required: - - max_file_path_length - repository-rule-file-extension-restriction: - title: file_extension_restriction - description: Prevent commits that include files with specified file extensions - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_extensions - repository-rule-max-file-size: - title: max_file_size - description: Prevent commits with individual files that exceed the specified - limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. This limit - does not apply to Git Large File Storage (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size repository-rule-params-restricted-commits: title: RestrictedCommits description: Restricted commit @@ -96236,6 +96219,98 @@ components: type: boolean description: Copilot automatically reviews each new push to the pull request. + repository-rule-file-path-restriction: + title: file_path_restriction + description: Prevent commits that include changes in specified file and folder + paths from being pushed to the commit graph. This includes absolute paths + that contain file names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed to + the commit graph. + items: + type: string + required: + - restricted_file_paths + repository-rule-max-file-path-length: + title: max_file_path_length + description: Prevent commits that include file paths that exceed the specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + repository-rule-file-extension-restriction: + title: file_extension_restriction + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + repository-rule-max-file-size: + title: max_file_size + description: Prevent commits with individual files that exceed the specified + limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size repository-rule: title: Repository Rule type: object @@ -96256,13 +96331,13 @@ components: - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-size" - - "$ref": "#/components/schemas/repository-rule-workflows" - - "$ref": "#/components/schemas/repository-rule-code-scanning" - - "$ref": "#/components/schemas/repository-rule-copilot-code-review" repository-ruleset: title: Repository ruleset type: object @@ -108483,25 +108558,25 @@ components: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-code-scanning" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-max-file-size" + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object @@ -247264,6 +247339,15 @@ components: node_id: MDU6SXNzdWUzNTgwMg== number: 132 title: Line Number Indexes Beyond 20 Not Displayed + type: + id: 1 + node_id: IT_kwDNJr9H + name: Bug + description: An unexpected problem or behavior + color: red + created_at: '2023-10-09T13:30:49Z' + updated_at: '2024-05-30T18:20:53Z' + is_enabled: true user: login: Nick3C id: 90254 diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 1293fbe68..f5feb7c89 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -6867,6 +6867,60 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot users usage metrics for a specific day", @@ -23139,7 +23193,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -23228,7 +23282,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -23399,7 +23453,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23453,7 +23507,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -23632,7 +23686,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23676,7 +23730,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23814,7 +23868,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -23983,7 +24037,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24153,7 +24207,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24219,7 +24273,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24309,7 +24363,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -24465,7 +24519,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -24538,7 +24592,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -24641,7 +24695,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -26027,6 +26081,63 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/day" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + }, + "examples": { + "default": { + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + } + } + } + } + }, + "204": { + "$ref": "#/components/responses/no_content" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -55076,6 +55187,15 @@ }, "403": { "$ref": "#/components/responses/dependency_review_forbidden" + }, + "400": { + "$ref": "#/components/responses/bad_request" + }, + "500": { + "$ref": "#/components/responses/internal_error" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" } }, "x-github": { @@ -60827,6 +60947,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "$ref": "#/components/parameters/labels" }, @@ -67976,94 +68105,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/pull-number" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "$ref": "#/components/parameters/owner" - }, - { - "$ref": "#/components/parameters/repo" - }, - { - "$ref": "#/components/parameters/pull-number" - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - }, - "422": { - "$ref": "#/components/responses/validation_failed" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -74964,7 +75005,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -119307,7 +119349,7 @@ }, "issue-type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -133096,128 +133138,6 @@ } } }, - "repository-rule-file-path-restriction": { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - "repository-rule-max-file-path-length": { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - "repository-rule-file-extension-restriction": { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - "repository-rule-max-file-size": { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, "repository-rule-params-restricted-commits": { "title": "RestrictedCommits", "description": "Restricted commit", @@ -133395,6 +133315,128 @@ } } }, + "repository-rule-file-path-restriction": { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + "repository-rule-max-file-path-length": { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + "repository-rule-file-extension-restriction": { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + "repository-rule-max-file-size": { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -133446,25 +133488,25 @@ "$ref": "#/components/schemas/repository-rule-tag-name-pattern" }, { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + "$ref": "#/components/schemas/repository-rule-workflows" }, { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + "$ref": "#/components/schemas/repository-rule-code-scanning" }, { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-copilot-code-review" }, { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + "$ref": "#/components/schemas/repository-rule-max-file-size" } ] }, @@ -150873,7 +150915,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + "$ref": "#/components/schemas/repository-rule-workflows" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -150883,7 +150925,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + "$ref": "#/components/schemas/repository-rule-code-scanning" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -150893,7 +150935,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + "$ref": "#/components/schemas/repository-rule-copilot-code-review" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -150903,7 +150945,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-max-file-size" + "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -150913,7 +150955,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-workflows" + "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -150923,7 +150965,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-code-scanning" + "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -150933,7 +150975,7 @@ { "allOf": [ { - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + "$ref": "#/components/schemas/repository-rule-max-file-size" }, { "$ref": "#/components/schemas/repository-rule-ruleset-info" @@ -334566,6 +334608,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 4eaefaba2..3108ea073 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -5185,6 +5185,47 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot enterprise user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/enterprise" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day @@ -17085,6 +17126,8 @@ paths: Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response. tags: - copilot-spaces operationId: copilot-spaces/list-for-org @@ -17150,6 +17193,8 @@ paths: Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources. tags: - copilot-spaces operationId: copilot-spaces/create-for-org @@ -17278,6 +17323,8 @@ paths: Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-for-org @@ -17318,6 +17365,8 @@ paths: Organization members with appropriate permissions can update Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated. tags: - copilot-spaces operationId: copilot-spaces/update-for-org @@ -17455,6 +17504,8 @@ paths: Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-for-org @@ -17491,6 +17542,8 @@ paths: **Note:** Team collaborators listed here are teams that are defined in the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-collaborators-for-org @@ -17605,6 +17658,8 @@ paths: When adding teams as collaborators, they must be defined in the organization. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/add-collaborator-for-org @@ -17738,6 +17793,8 @@ paths: Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/update-collaborator-for-org @@ -17872,6 +17929,8 @@ paths: Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/remove-collaborator-for-org @@ -17921,6 +17980,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-resources-for-org @@ -17989,6 +18050,8 @@ paths: For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created. tags: - copilot-spaces operationId: copilot-spaces/create-resource-for-org @@ -18099,6 +18162,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-resource-for-org @@ -18152,6 +18217,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated. tags: - copilot-spaces operationId: copilot-spaces/update-resource-for-org @@ -18224,6 +18291,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-resource-for-org @@ -19330,6 +19399,51 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot organization user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/day" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/copilot-usage-metrics-1-day-report" + examples: + default: + "$ref": "#/components/examples/copilot-usage-metrics-1-day-report" + '204': + "$ref": "#/components/responses/no_content" + '500': + "$ref": "#/components/responses/internal_error" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot organization users usage metrics for a specific day @@ -40482,6 +40596,12 @@ paths: "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/dependency_review_forbidden" + '400': + "$ref": "#/components/responses/bad_request" + '500': + "$ref": "#/components/responses/internal_error" + '503': + "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: false category: dependency-graph @@ -44762,6 +44882,20 @@ paths: required: false schema: type: string + - name: issue_field_values + description: |- + A comma-separated list of issue field filters in `field_slug:value` format. + Only issues matching all specified field values are returned. + Requires issue fields to be enabled for the repository. Issue fields are + not available for user-owned repositories, and field availability for + organization-owned public repositories depends on the organization's + visibility settings. For example, `priority:Urgent,severity:High` filters + issues where the `priority` field is `Urgent` AND the `severity` field is + `High`. + in: query + required: false + schema: + type: string - "$ref": "#/components/parameters/labels" - name: sort description: What to sort results by. @@ -49753,67 +49887,6 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": - put: - summary: Archive a pull request - description: |- - Archives a pull request. Closes, locks, and marks the pull request as archived. - Only repository admins can archive pull requests. - Archived pull requests are hidden from non-admin users. - tags: - - pulls - operationId: pulls/archive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/pull-number" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - delete: - summary: Unarchive a pull request - description: |- - Unarchives a pull request. Removes the archived flag from the pull request. - Does not automatically reopen or unlock the pull request. - Only repository admins can unarchive pull requests. - tags: - - pulls - operationId: pulls/unarchive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request - parameters: - - "$ref": "#/components/parameters/owner" - - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/pull-number" - responses: - '204': - description: Response - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - '422': - "$ref": "#/components/responses/validation_failed" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -54748,6 +54821,7 @@ paths: - no_accessible_repos - server_error - only_non_semantic_fields_requested + - service_unavailable examples: default: "$ref": "#/components/examples/issue-search-result-item-paginated" @@ -86750,7 +86824,8 @@ components: - updated_at issue-type: title: Issue Type - description: The type of issue. + description: The type assigned to the issue. This is only present for issues + in repositories where issue types are supported. type: - object - 'null' @@ -97027,98 +97102,6 @@ components: required: - operator - pattern - repository-rule-file-path-restriction: - title: file_path_restriction - description: Prevent commits that include changes in specified file and folder - paths from being pushed to the commit graph. This includes absolute paths - that contain file names. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted from being pushed to - the commit graph. - items: - type: string - required: - - restricted_file_paths - repository-rule-max-file-path-length: - title: max_file_path_length - description: Prevent commits that include file paths that exceed the specified - character limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed in file paths. - minimum: 1 - maximum: 32767 - required: - - max_file_path_length - repository-rule-file-extension-restriction: - title: file_extension_restriction - description: Prevent commits that include files with specified file extensions - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_extensions - repository-rule-max-file-size: - title: max_file_size - description: Prevent commits with individual files that exceed the specified - limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. This limit - does not apply to Git Large File Storage (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size repository-rule-params-restricted-commits: title: RestrictedCommits description: Restricted commit @@ -97260,6 +97243,98 @@ components: type: boolean description: Copilot automatically reviews each new push to the pull request. + repository-rule-file-path-restriction: + title: file_path_restriction + description: Prevent commits that include changes in specified file and folder + paths from being pushed to the commit graph. This includes absolute paths + that contain file names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed to + the commit graph. + items: + type: string + required: + - restricted_file_paths + repository-rule-max-file-path-length: + title: max_file_path_length + description: Prevent commits that include file paths that exceed the specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + repository-rule-file-extension-restriction: + title: file_extension_restriction + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + repository-rule-max-file-size: + title: max_file_size + description: Prevent commits with individual files that exceed the specified + limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size repository-rule: title: Repository Rule type: object @@ -97280,13 +97355,13 @@ components: - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-max-file-size" - - "$ref": "#/components/schemas/repository-rule-workflows" - - "$ref": "#/components/schemas/repository-rule-code-scanning" - - "$ref": "#/components/schemas/repository-rule-copilot-code-review" repository-ruleset: title: Repository ruleset type: object @@ -109783,25 +109858,25 @@ components: - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-file-path-restriction" + - "$ref": "#/components/schemas/repository-rule-workflows" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-max-file-path-length" + - "$ref": "#/components/schemas/repository-rule-code-scanning" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" + - "$ref": "#/components/schemas/repository-rule-copilot-code-review" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-max-file-size" + - "$ref": "#/components/schemas/repository-rule-file-path-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-max-file-path-length" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-code-scanning" + - "$ref": "#/components/schemas/repository-rule-file-extension-restriction" - "$ref": "#/components/schemas/repository-rule-ruleset-info" - allOf: - - "$ref": "#/components/schemas/repository-rule-copilot-code-review" + - "$ref": "#/components/schemas/repository-rule-max-file-size" - "$ref": "#/components/schemas/repository-rule-ruleset-info" secret-scanning-alert: type: object @@ -249376,6 +249451,15 @@ components: node_id: MDU6SXNzdWUzNTgwMg== number: 132 title: Line Number Indexes Beyond 20 Not Displayed + type: + id: 1 + node_id: IT_kwDNJr9H + name: Bug + description: An unexpected problem or behavior + color: red + created_at: '2023-10-09T13:30:49Z' + updated_at: '2024-05-30T18:20:53Z' + is_enabled: true user: login: Nick3C id: 90254 diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 11572886a..15606025d 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -27653,17 +27653,17 @@ } } }, - "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { "get": { - "summary": "Get Copilot users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-users-one-day-usage-metrics", + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" }, "parameters": [ { @@ -27819,17 +27819,17 @@ } } }, - "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { - "summary": "Get Copilot users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-users-usage-metrics", + "operationId": "copilot/copilot-users-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -27840,6 +27840,19 @@ "schema": { "type": "string" } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } } ], "responses": { @@ -27849,8 +27862,8 @@ "application/json": { "schema": { "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { "download_links": { "type": "array", @@ -27858,23 +27871,17 @@ "type": "string", "format": "uri" }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." }, - "report_end_day": { + "report_day": { "type": "string", "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." + "description": "The day of the report in `YYYY-MM-DD` format." } }, "required": [ "download_links", - "report_start_day", - "report_end_day" + "report_day" ] }, "examples": { @@ -27884,8 +27891,7 @@ "https://example.com/copilot-usage-report-1.json", "https://example.com/copilot-usage-report-2.json" ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" + "report_day": "2025-07-01" } } } @@ -27979,17 +27985,17 @@ } } }, - "/enterprises/{enterprise}/copilot/policies/coding_agent": { - "put": { - "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/set-enterprise-coding-agent-policy", + "operationId": "copilot/copilot-users-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" }, "parameters": [ { @@ -28002,46 +28008,58 @@ } } ], - "requestBody": { - "description": "The coding agent policy configuration", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "policy_state": { - "type": "string", - "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", - "enum": [ - "enabled_for_all_orgs", - "disabled_for_all_orgs", - "enabled_for_selected_orgs", - "configured_by_org_admins" - ] - } + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] }, - "required": [ - "policy_state" - ] - }, - "examples": { - "default": { - "summary": "Enable coding agent for all organizations", - "value": { - "policy_state": "enabled_for_all_orgs" + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } } } } } - } - }, - "responses": { - "204": { - "description": "A header with no content is returned." }, - "400": { - "description": "Bad Request", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -28063,45 +28081,55 @@ } } } - }, - "application/scim+json": { + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "title": "Scim Error", - "description": "Scim Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { - "type": [ - "string", - "null" - ] + "type": "string" }, "documentation_url": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "detail": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, "status": { - "type": "integer" + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "scimType": { - "type": [ - "string", - "null" - ] + "documentation_url": { + "type": "string" }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -28110,23 +28138,24 @@ } }, "x-github": { - "enabledForGitHubApps": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "subcategory": "copilot-usage-metrics" } } }, - "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { - "post": { - "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "/enterprises/{enterprise}/copilot/policies/coding_agent": { + "put": { + "summary": "Set the coding agent policy for an enterprise", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", + "operationId": "copilot/set-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" }, "parameters": [ { @@ -28140,63 +28169,200 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot cloud agent for", + "description": "The coding agent policy configuration", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "organizations": { - "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", - "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "array", - "description": "List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.", - "items": { - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the custom property to filter by." - }, - "values": { - "type": "array", - "description": "The values of the custom property to match.", - "items": { - "type": "string" - } - } - }, - "required": [ - "property_name", - "values" - ] - } + "policy_state": { + "type": "string", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "enum": [ + "enabled_for_all_orgs", + "disabled_for_all_orgs", + "enabled_for_selected_orgs", + "configured_by_org_admins" + ] } - } + }, + "required": [ + "policy_state" + ] }, "examples": { "default": { - "summary": "Add organizations that match a login or have a custom property", + "summary": "Enable coding agent for all organizations", "value": { - "organizations": [ - "my-org-1", - "my-org-2" - ], - "custom_properties": [ - { - "property_name": "department", - "values": [ - "engineering", - "security" - ] - } - ] + "policy_state": "enabled_for_all_orgs" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { + "post": { + "summary": "Add organizations to the enterprise coding agent policy", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The organizations to enable Copilot cloud agent for", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organizations": { + "type": "array", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "array", + "description": "List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.", + "items": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the custom property to filter by." + }, + "values": { + "type": "array", + "description": "The values of the custom property to match.", + "items": { + "type": "string" + } + } + }, + "required": [ + "property_name", + "values" + ] + } + } + } + }, + "examples": { + "default": { + "summary": "Add organizations that match a login or have a custom property", + "value": { + "organizations": [ + "my-org-1", + "my-org-2" + ], + "custom_properties": [ + { + "property_name": "department", + "values": [ + "engineering", + "security" + ] + } + ] } } } @@ -36925,7 +37091,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -41279,7 +41445,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -63737,7 +63903,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -72163,7 +72329,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -76517,7 +76683,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -131497,7 +131663,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -132391,7 +132557,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -133397,7 +133563,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -134214,7 +134380,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -135228,7 +135394,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -135373,7 +135539,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -135847,7 +136013,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -136424,7 +136590,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -137002,7 +137168,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -137120,7 +137286,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -137312,7 +137478,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -137692,7 +137858,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -137867,7 +138033,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -138144,7 +138310,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -144208,6 +144374,175 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -153014,7 +153349,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -157368,7 +157703,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -173507,7 +173842,7 @@ "type": "array", "items": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -173720,7 +174055,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -173963,7 +174298,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -175586,7 +175921,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -207760,7 +208095,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -219327,7 +219662,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -244020,128 +244355,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -244294,6 +244507,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -246676,128 +247011,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -246950,6 +247163,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -248782,6 +249117,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -248903,159 +249391,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -251459,128 +251794,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -251733,6 +251946,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -401786,6 +402121,121 @@ } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -415522,7 +415972,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -419876,7 +420326,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -446600,6 +447050,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "labels", "description": "A list of comma separated label names. Example: `bug,ui,@high`", @@ -447915,7 +448374,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -452272,7 +452731,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -462770,7 +463229,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -468700,7 +469159,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -474426,7 +474885,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -478986,7 +479445,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -483297,7 +483756,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -487405,7 +487864,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -493903,7 +494362,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -498098,7 +498557,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -502377,7 +502836,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -506678,7 +507137,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -525628,7 +526087,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -530976,7 +531435,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -535181,7 +535640,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -539354,7 +539813,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -543632,7 +544091,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -558608,7 +559067,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -598798,366 +599257,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -630978,8 +631077,8 @@ { "allOf": [ { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", "type": "object", "required": [ "type" @@ -630988,22 +631087,50 @@ "type": { "type": "string", "enum": [ - "file_path_restriction" + "workflows" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_paths": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", + "description": "Workflows that must pass for this rule to pass.", "items": { - "type": "string" + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] } } }, "required": [ - "restricted_file_paths" + "workflows" ] } } @@ -631035,8 +631162,8 @@ { "allOf": [ { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", "type": "object", "required": [ "type" @@ -631045,21 +631172,56 @@ "type": { "type": "string", "enum": [ - "max_file_path_length" + "code_scanning" ] }, "parameters": { "type": "object", "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } } }, "required": [ - "max_file_path_length" + "code_scanning_tools" ] } } @@ -631091,8 +631253,8 @@ { "allOf": [ { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -631101,23 +631263,21 @@ "type": { "type": "string", "enum": [ - "file_extension_restriction" + "copilot_code_review" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." } - }, - "required": [ - "restricted_file_extensions" - ] + } } } }, @@ -631148,8 +631308,8 @@ { "allOf": [ { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", "type": "object", "required": [ "type" @@ -631158,21 +631318,22 @@ "type": { "type": "string", "enum": [ - "max_file_size" + "file_path_restriction" ] }, "parameters": { "type": "object", "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } }, "required": [ - "max_file_size" + "restricted_file_paths" ] } } @@ -631204,8 +631365,8 @@ { "allOf": [ { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -631214,50 +631375,21 @@ "type": { "type": "string", "enum": [ - "workflows" + "max_file_path_length" ] }, "parameters": { "type": "object", "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 } }, "required": [ - "workflows" + "max_file_path_length" ] } } @@ -631289,8 +631421,8 @@ { "allOf": [ { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -631299,56 +631431,22 @@ "type": { "type": "string", "enum": [ - "code_scanning" + "file_extension_restriction" ] }, "parameters": { "type": "object", "properties": { - "code_scanning_tools": { + "restricted_file_extensions": { "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", + "description": "The file extensions that are restricted from being pushed to the commit graph.", "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] + "type": "string" } } }, "required": [ - "code_scanning_tools" + "restricted_file_extensions" ] } } @@ -631380,8 +631478,8 @@ { "allOf": [ { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -631390,21 +631488,22 @@ "type": { "type": "string", "enum": [ - "copilot_code_review" + "max_file_size" ] }, "parameters": { "type": "object", "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 } - } + }, + "required": [ + "max_file_size" + ] } } }, @@ -632593,128 +632692,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -632867,6 +632844,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -633743,6 +633842,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -633864,159 +634116,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -635106,128 +635205,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -635380,6 +635357,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -637231,6 +637330,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -637352,159 +637604,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -638396,128 +638495,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -638670,6 +638647,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -639755,6 +639854,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -639876,159 +640128,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -682188,7 +682287,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -683686,7 +683785,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -683711,6 +683811,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, @@ -727364,7 +727474,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -760673,7 +760783,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -780777,7 +780887,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -785131,7 +785241,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -793795,7 +793905,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -798149,7 +798259,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -806823,7 +806933,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -811177,7 +811287,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -831313,7 +831423,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -847682,7 +847792,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -852036,7 +852146,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -860696,7 +860806,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -865050,7 +865160,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1076436,7 +1076546,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1080951,7 +1081061,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1085490,7 +1085600,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1090013,7 +1090123,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1094538,7 +1094648,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1098216,7 +1098326,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1102081,7 +1102191,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1108819,7 +1108929,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1112684,7 +1112794,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1119422,7 +1119532,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1124255,7 +1124365,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1130025,7 +1130135,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1134858,7 +1134968,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1141785,7 +1141895,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1146171,7 +1146281,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1150765,7 +1150875,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1155163,7 +1155273,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1159738,7 +1159848,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1164167,7 +1164277,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1168709,7 +1168819,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1173171,7 +1173281,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1177621,7 +1177731,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1181999,7 +1182109,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1186544,7 +1186654,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1188633,7 +1188743,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1193935,7 +1194045,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1198446,7 +1198556,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1202576,7 +1202686,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1205718,7 +1205828,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1210099,7 +1210209,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1210301,7 +1210411,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1214649,7 +1214759,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1219030,7 +1219140,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1223478,7 +1223588,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1227829,7 +1227939,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1232209,7 +1232319,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1232411,7 +1232521,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1574044,128 +1574154,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1574318,6 +1574306,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1577361,6 +1577471,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1577482,159 +1577745,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1580678,128 +1580788,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1580952,6 +1580940,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1581752,6 +1581862,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1581873,159 +1582136,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1582654,128 +1582764,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1582928,6 +1582916,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1583559,128 +1583669,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1583833,6 +1583821,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] }, @@ -1657606,7 +1657716,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1662439,7 +1662549,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1668210,7 +1668320,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1673043,7 +1673153,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1678814,7 +1678924,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1683647,7 +1683757,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1689418,7 +1689528,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1694251,7 +1694361,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 9f424e0cf..005d33f8a 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -11994,6 +11994,42 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot enterprise user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day + parameters: + - *38 + - *54 + responses: + '200': + description: Response + content: + application/json: + schema: *55 + examples: + default: *56 + '500': *53 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day @@ -15151,7 +15187,9 @@ paths: format: uri type: &243 title: Issue Type - description: The type of issue. + description: The type assigned to the issue. This + is only present for issues in repositories where + issue types are supported. type: - object - 'null' @@ -34469,6 +34507,8 @@ paths: Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response. tags: - copilot-spaces operationId: copilot-spaces/list-for-org @@ -34801,6 +34841,8 @@ paths: Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources. tags: - copilot-spaces operationId: copilot-spaces/create-for-org @@ -34991,6 +35033,8 @@ paths: Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-for-org @@ -35027,6 +35071,8 @@ paths: Organization members with appropriate permissions can update Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated. tags: - copilot-spaces operationId: copilot-spaces/update-for-org @@ -35159,6 +35205,8 @@ paths: Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-for-org @@ -35193,6 +35241,8 @@ paths: **Note:** Team collaborators listed here are teams that are defined in the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-collaborators-for-org @@ -35385,6 +35435,8 @@ paths: When adding teams as collaborators, they must be defined in the organization. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/add-collaborator-for-org @@ -35514,6 +35566,8 @@ paths: Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/update-collaborator-for-org @@ -35644,6 +35698,8 @@ paths: Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/remove-collaborator-for-org @@ -35691,6 +35747,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-resources-for-org @@ -35799,6 +35857,8 @@ paths: For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created. tags: - copilot-spaces operationId: copilot-spaces/create-resource-for-org @@ -35904,6 +35964,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-resource-for-org @@ -35954,6 +36016,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated. tags: - copilot-spaces operationId: copilot-spaces/update-resource-for-org @@ -36022,6 +36086,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-resource-for-org @@ -37711,6 +37777,45 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot organization user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day + parameters: + - *74 + - *54 + responses: + '200': + description: Response + content: + application/json: + schema: *55 + examples: + default: *56 + '204': *59 + '500': *53 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot organization users usage metrics for a specific day @@ -51674,103 +51779,6 @@ paths: required: - operator - pattern - - &314 - title: file_path_restriction - description: Prevent commits that include changes in specified - file and folder paths from being pushed to the commit - graph. This includes absolute paths that contain file - names. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_paths - - &315 - title: max_file_path_length - description: Prevent commits that include file paths that - exceed the specified character limit from being pushed - to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed - in file paths. - minimum: 1 - maximum: 32767 - required: - - max_file_path_length - - &316 - title: file_extension_restriction - description: Prevent commits that include files with specified - file extensions from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - &317 - title: max_file_size - description: Prevent commits with individual files that - exceed the specified limit from being pushed to the commit - graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. - This limit does not apply to Git Large File Storage - (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - &318 title: workflows description: Require all changes made to a targeted branch @@ -51908,6 +51916,103 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. + - &314 + title: file_path_restriction + description: Prevent commits that include changes in specified + file and folder paths from being pushed to the commit + graph. This includes absolute paths that contain file + names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_paths + - &315 + title: max_file_path_length + description: Prevent commits that include file paths that + exceed the specified character limit from being pushed + to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed + in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + - &316 + title: file_extension_restriction + description: Prevent commits that include files with specified + file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - &317 + title: max_file_size + description: Prevent commits with individual files that + exceed the specified limit from being pushed to the commit + graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. + This limit does not apply to Git Large File Storage + (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size created_at: type: string format: date-time @@ -80744,6 +80849,9 @@ paths: content: application/json: schema: *3 + '400': *14 + '500': *53 + '503': *114 x-github: githubCloudOnly: false category: dependency-graph @@ -87272,6 +87380,20 @@ paths: required: false schema: type: string + - name: issue_field_values + description: |- + A comma-separated list of issue field filters in `field_slug:value` format. + Only issues matching all specified field values are returned. + Requires issue fields to be enabled for the repository. Issue fields are + not available for user-owned repositories, and field availability for + organization-owned public repositories depends on the organization's + visibility settings. For example, `priority:Urgent,severity:High` filters + issues where the `priority` field is `Urgent` AND the `severity` field is + `High`. + in: query + required: false + schema: + type: string - *246 - name: sort description: What to sort results by. @@ -96532,61 +96654,6 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": - put: - summary: Archive a pull request - description: |- - Archives a pull request. Closes, locks, and marks the pull request as archived. - Only repository admins can archive pull requests. - Archived pull requests are hidden from non-admin users. - tags: - - pulls - operationId: pulls/archive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request - parameters: - - *338 - - *339 - - *581 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - delete: - summary: Unarchive a pull request - description: |- - Unarchives a pull request. Removes the archived flag from the pull request. - Does not automatically reopen or unlock the pull request. - Only repository admins can unarchive pull requests. - tags: - - pulls - operationId: pulls/unarchive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request - parameters: - - *338 - - *339 - - *581 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -100737,25 +100804,25 @@ paths: - *313 - *596 - allOf: - - *314 + - *318 - *596 - allOf: - - *315 + - *319 - *596 - allOf: - - *316 + - *320 - *596 - allOf: - - *317 + - *314 - *596 - allOf: - - *318 + - *315 - *596 - allOf: - - *319 + - *316 - *596 - allOf: - - *320 + - *317 - *596 examples: default: @@ -106106,6 +106173,7 @@ paths: - no_accessible_repos - server_error - only_non_semantic_fields_requested + - service_unavailable examples: default: summary: Hybrid search response @@ -106124,6 +106192,15 @@ paths: node_id: MDU6SXNzdWUzNTgwMg== number: 132 title: Line Number Indexes Beyond 20 Not Displayed + type: + id: 1 + node_id: IT_kwDNJr9H + name: Bug + description: An unexpected problem or behavior + color: red + created_at: '2023-10-09T13:30:49Z' + updated_at: '2024-05-30T18:20:53Z' + is_enabled: true user: login: Nick3C id: 90254 diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 41bfff7c2..b87fe0ee1 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -27558,17 +27558,17 @@ } } }, - "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { "get": { - "summary": "Get Copilot users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-users-one-day-usage-metrics", + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" }, "parameters": [ { @@ -27724,17 +27724,17 @@ } } }, - "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { - "summary": "Get Copilot users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-users-usage-metrics", + "operationId": "copilot/copilot-users-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -27745,6 +27745,19 @@ "schema": { "type": "string" } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } } ], "responses": { @@ -27754,8 +27767,8 @@ "application/json": { "schema": { "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { "download_links": { "type": "array", @@ -27763,23 +27776,17 @@ "type": "string", "format": "uri" }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." }, - "report_end_day": { + "report_day": { "type": "string", "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." + "description": "The day of the report in `YYYY-MM-DD` format." } }, "required": [ "download_links", - "report_start_day", - "report_end_day" + "report_day" ] }, "examples": { @@ -27789,8 +27796,7 @@ "https://example.com/copilot-usage-report-1.json", "https://example.com/copilot-usage-report-2.json" ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" + "report_day": "2025-07-01" } } } @@ -27884,17 +27890,17 @@ } } }, - "/enterprises/{enterprise}/copilot/policies/coding_agent": { - "put": { - "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/set-enterprise-coding-agent-policy", + "operationId": "copilot/copilot-users-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" }, "parameters": [ { @@ -27907,46 +27913,58 @@ } } ], - "requestBody": { - "description": "The coding agent policy configuration", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "policy_state": { - "type": "string", - "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", - "enum": [ - "enabled_for_all_orgs", - "disabled_for_all_orgs", - "enabled_for_selected_orgs", - "configured_by_org_admins" - ] - } + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] }, - "required": [ - "policy_state" - ] - }, - "examples": { - "default": { - "summary": "Enable coding agent for all organizations", - "value": { - "policy_state": "enabled_for_all_orgs" + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } } } } } - } - }, - "responses": { - "204": { - "description": "A header with no content is returned." }, - "400": { - "description": "Bad Request", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -27968,45 +27986,55 @@ } } } - }, - "application/scim+json": { + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "title": "Scim Error", - "description": "Scim Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { - "type": [ - "string", - "null" - ] + "type": "string" }, "documentation_url": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "detail": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, "status": { - "type": "integer" + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "scimType": { - "type": [ - "string", - "null" - ] + "documentation_url": { + "type": "string" }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -28015,23 +28043,24 @@ } }, "x-github": { - "enabledForGitHubApps": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "subcategory": "copilot-usage-metrics" } } }, - "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { - "post": { - "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "/enterprises/{enterprise}/copilot/policies/coding_agent": { + "put": { + "summary": "Set the coding agent policy for an enterprise", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", + "operationId": "copilot/set-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" }, "parameters": [ { @@ -28045,63 +28074,200 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot cloud agent for", + "description": "The coding agent policy configuration", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "organizations": { - "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", - "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "array", - "description": "List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.", - "items": { - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the custom property to filter by." - }, - "values": { - "type": "array", - "description": "The values of the custom property to match.", - "items": { - "type": "string" - } - } - }, - "required": [ - "property_name", - "values" - ] - } + "policy_state": { + "type": "string", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "enum": [ + "enabled_for_all_orgs", + "disabled_for_all_orgs", + "enabled_for_selected_orgs", + "configured_by_org_admins" + ] } - } + }, + "required": [ + "policy_state" + ] }, "examples": { "default": { - "summary": "Add organizations that match a login or have a custom property", + "summary": "Enable coding agent for all organizations", "value": { - "organizations": [ - "my-org-1", - "my-org-2" - ], - "custom_properties": [ - { - "property_name": "department", - "values": [ - "engineering", - "security" - ] - } - ] + "policy_state": "enabled_for_all_orgs" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { + "post": { + "summary": "Add organizations to the enterprise coding agent policy", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The organizations to enable Copilot cloud agent for", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organizations": { + "type": "array", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "array", + "description": "List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.", + "items": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the custom property to filter by." + }, + "values": { + "type": "array", + "description": "The values of the custom property to match.", + "items": { + "type": "string" + } + } + }, + "required": [ + "property_name", + "values" + ] + } + } + } + }, + "examples": { + "default": { + "summary": "Add organizations that match a login or have a custom property", + "value": { + "organizations": [ + "my-org-1", + "my-org-2" + ], + "custom_properties": [ + { + "property_name": "department", + "values": [ + "engineering", + "security" + ] + } + ] } } } @@ -36632,7 +36798,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -40796,7 +40962,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -59908,7 +60074,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -68144,7 +68310,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -72308,7 +72474,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -127179,7 +127345,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -128073,7 +128239,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -129079,7 +129245,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -129896,7 +130062,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -130910,7 +131076,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -131055,7 +131221,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -131529,7 +131695,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -132106,7 +132272,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -132684,7 +132850,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -132802,7 +132968,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -132994,7 +133160,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -133374,7 +133540,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -133549,7 +133715,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -133826,7 +133992,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -139887,6 +140053,175 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -148482,7 +148817,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -152646,7 +152981,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -168765,7 +169100,7 @@ "type": "array", "items": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -168978,7 +169313,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -169221,7 +169556,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -170674,7 +171009,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -201032,7 +201367,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -212185,7 +212520,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -236636,128 +236971,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -236910,6 +237123,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -239292,128 +239627,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -239566,6 +239779,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -241398,6 +241733,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -241519,159 +242007,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -244075,128 +244410,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -244349,6 +244562,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -393748,6 +394083,121 @@ } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -407314,7 +407764,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -411478,7 +411928,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -438103,6 +438553,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "labels", "description": "A list of comma separated label names. Example: `bug,ui,@high`", @@ -439248,7 +439707,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -443408,7 +443867,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -453696,7 +454155,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -459436,7 +459895,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -464972,7 +465431,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -469295,7 +469754,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -473396,7 +473855,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -477294,7 +477753,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -483582,7 +484041,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -487587,7 +488046,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -491656,7 +492115,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -495747,7 +496206,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -514507,7 +514966,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -519645,7 +520104,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -523640,7 +524099,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -527623,7 +528082,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -531691,7 +532150,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -546457,7 +546916,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -585665,366 +586124,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -617370,8 +617469,8 @@ { "allOf": [ { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", "type": "object", "required": [ "type" @@ -617380,22 +617479,50 @@ "type": { "type": "string", "enum": [ - "file_path_restriction" + "workflows" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_paths": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", + "description": "Workflows that must pass for this rule to pass.", "items": { - "type": "string" + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] } } }, "required": [ - "restricted_file_paths" + "workflows" ] } } @@ -617427,8 +617554,8 @@ { "allOf": [ { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", "type": "object", "required": [ "type" @@ -617437,21 +617564,56 @@ "type": { "type": "string", "enum": [ - "max_file_path_length" + "code_scanning" ] }, "parameters": { "type": "object", "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } } }, "required": [ - "max_file_path_length" + "code_scanning_tools" ] } } @@ -617483,8 +617645,8 @@ { "allOf": [ { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -617493,23 +617655,21 @@ "type": { "type": "string", "enum": [ - "file_extension_restriction" + "copilot_code_review" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." } - }, - "required": [ - "restricted_file_extensions" - ] + } } } }, @@ -617540,8 +617700,8 @@ { "allOf": [ { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", "type": "object", "required": [ "type" @@ -617550,21 +617710,22 @@ "type": { "type": "string", "enum": [ - "max_file_size" + "file_path_restriction" ] }, "parameters": { "type": "object", "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } }, "required": [ - "max_file_size" + "restricted_file_paths" ] } } @@ -617596,8 +617757,8 @@ { "allOf": [ { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -617606,50 +617767,21 @@ "type": { "type": "string", "enum": [ - "workflows" + "max_file_path_length" ] }, "parameters": { "type": "object", "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 } }, "required": [ - "workflows" + "max_file_path_length" ] } } @@ -617681,8 +617813,8 @@ { "allOf": [ { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -617691,56 +617823,22 @@ "type": { "type": "string", "enum": [ - "code_scanning" + "file_extension_restriction" ] }, "parameters": { "type": "object", "properties": { - "code_scanning_tools": { + "restricted_file_extensions": { "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", + "description": "The file extensions that are restricted from being pushed to the commit graph.", "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] + "type": "string" } } }, "required": [ - "code_scanning_tools" + "restricted_file_extensions" ] } } @@ -617772,8 +617870,8 @@ { "allOf": [ { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -617782,21 +617880,22 @@ "type": { "type": "string", "enum": [ - "copilot_code_review" + "max_file_size" ] }, "parameters": { "type": "object", "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 } - } + }, + "required": [ + "max_file_size" + ] } } }, @@ -618985,128 +619084,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -619259,6 +619236,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -620135,6 +620234,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -620256,159 +620508,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -621498,128 +621597,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -621772,6 +621749,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -623623,6 +623722,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -623744,159 +623996,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -624788,128 +624887,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -625062,6 +625039,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -626147,6 +626246,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -626268,159 +626520,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -668066,7 +668165,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -669563,7 +669662,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -669588,6 +669688,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, @@ -712942,7 +713052,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -744314,7 +744424,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -763963,7 +764073,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -768127,7 +768237,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -776601,7 +776711,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -780765,7 +780875,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -789249,7 +789359,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -793413,7 +793523,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -813169,7 +813279,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -829124,7 +829234,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -833288,7 +833398,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -841758,7 +841868,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -845922,7 +846032,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1055968,7 +1056078,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1060471,7 +1060581,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1064998,7 +1065108,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1069509,7 +1069619,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1074022,7 +1074132,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1077518,7 +1077628,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1081193,7 +1081303,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1087710,7 +1087820,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1091385,7 +1091495,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1097902,7 +1098012,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1102526,7 +1102636,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1108094,7 +1108204,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1112718,7 +1112828,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1119613,7 +1119723,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1123987,7 +1124097,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1128569,7 +1128679,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1132955,7 +1133065,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1137518,7 +1137628,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1141935,7 +1142045,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1146465,7 +1146575,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1150915,7 +1151025,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1155353,7 +1155463,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1159719,7 +1159829,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1164252,7 +1164362,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1166341,7 +1166451,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1171631,7 +1171741,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1176130,7 +1176240,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1180248,7 +1180358,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1183390,7 +1183500,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1187759,7 +1187869,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1187961,7 +1188071,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1192297,7 +1192407,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1196666,7 +1196776,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1201102,7 +1201212,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1205441,7 +1205551,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1209809,7 +1209919,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1210011,7 +1210121,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1548685,128 +1548795,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1548959,6 +1548947,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1551990,6 +1552100,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1552111,159 +1552374,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1555295,128 +1555405,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1555569,6 +1555557,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1556369,6 +1556479,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1556490,159 +1556753,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1557271,128 +1557381,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1557545,6 +1557533,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1558176,128 +1558286,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1558450,6 +1558438,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] }, @@ -1631603,7 +1631713,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1636227,7 +1636337,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1641796,7 +1641906,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1646420,7 +1646530,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1651989,7 +1652099,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1656613,7 +1656723,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1662182,7 +1662292,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1666806,7 +1666916,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index d12996c27..06d1a3243 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -11942,6 +11942,42 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot enterprise user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day + parameters: + - *38 + - *54 + responses: + '200': + description: Response + content: + application/json: + schema: *55 + examples: + default: *56 + '500': *53 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day @@ -15077,7 +15113,9 @@ paths: format: uri type: &243 title: Issue Type - description: The type of issue. + description: The type assigned to the issue. This + is only present for issues in repositories where + issue types are supported. type: - object - 'null' @@ -34113,6 +34151,8 @@ paths: Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response. tags: - copilot-spaces operationId: copilot-spaces/list-for-org @@ -34445,6 +34485,8 @@ paths: Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources. tags: - copilot-spaces operationId: copilot-spaces/create-for-org @@ -34635,6 +34677,8 @@ paths: Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-for-org @@ -34671,6 +34715,8 @@ paths: Organization members with appropriate permissions can update Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated. tags: - copilot-spaces operationId: copilot-spaces/update-for-org @@ -34803,6 +34849,8 @@ paths: Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-for-org @@ -34837,6 +34885,8 @@ paths: **Note:** Team collaborators listed here are teams that are defined in the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-collaborators-for-org @@ -35029,6 +35079,8 @@ paths: When adding teams as collaborators, they must be defined in the organization. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/add-collaborator-for-org @@ -35158,6 +35210,8 @@ paths: Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/update-collaborator-for-org @@ -35288,6 +35342,8 @@ paths: Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/remove-collaborator-for-org @@ -35335,6 +35391,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-resources-for-org @@ -35443,6 +35501,8 @@ paths: For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created. tags: - copilot-spaces operationId: copilot-spaces/create-resource-for-org @@ -35548,6 +35608,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-resource-for-org @@ -35598,6 +35660,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated. tags: - copilot-spaces operationId: copilot-spaces/update-resource-for-org @@ -35666,6 +35730,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-resource-for-org @@ -37355,6 +37421,45 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot organization user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day + parameters: + - *74 + - *54 + responses: + '200': + description: Response + content: + application/json: + schema: *55 + examples: + default: *56 + '204': *59 + '500': *53 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot organization users usage metrics for a specific day @@ -51296,103 +51401,6 @@ paths: required: - operator - pattern - - &314 - title: file_path_restriction - description: Prevent commits that include changes in specified - file and folder paths from being pushed to the commit - graph. This includes absolute paths that contain file - names. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_paths - - &315 - title: max_file_path_length - description: Prevent commits that include file paths that - exceed the specified character limit from being pushed - to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed - in file paths. - minimum: 1 - maximum: 32767 - required: - - max_file_path_length - - &316 - title: file_extension_restriction - description: Prevent commits that include files with specified - file extensions from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - &317 - title: max_file_size - description: Prevent commits with individual files that - exceed the specified limit from being pushed to the commit - graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. - This limit does not apply to Git Large File Storage - (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - &318 title: workflows description: Require all changes made to a targeted branch @@ -51530,6 +51538,103 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. + - &314 + title: file_path_restriction + description: Prevent commits that include changes in specified + file and folder paths from being pushed to the commit + graph. This includes absolute paths that contain file + names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_paths + - &315 + title: max_file_path_length + description: Prevent commits that include file paths that + exceed the specified character limit from being pushed + to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed + in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + - &316 + title: file_extension_restriction + description: Prevent commits that include files with specified + file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - &317 + title: max_file_size + description: Prevent commits with individual files that + exceed the specified limit from being pushed to the commit + graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. + This limit does not apply to Git Large File Storage + (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size created_at: type: string format: date-time @@ -80295,6 +80400,9 @@ paths: content: application/json: schema: *3 + '400': *14 + '500': *53 + '503': *114 x-github: githubCloudOnly: false category: dependency-graph @@ -86823,6 +86931,20 @@ paths: required: false schema: type: string + - name: issue_field_values + description: |- + A comma-separated list of issue field filters in `field_slug:value` format. + Only issues matching all specified field values are returned. + Requires issue fields to be enabled for the repository. Issue fields are + not available for user-owned repositories, and field availability for + organization-owned public repositories depends on the organization's + visibility settings. For example, `priority:Urgent,severity:High` filters + issues where the `priority` field is `Urgent` AND the `severity` field is + `High`. + in: query + required: false + schema: + type: string - *246 - name: sort description: What to sort results by. @@ -95999,61 +96121,6 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": - put: - summary: Archive a pull request - description: |- - Archives a pull request. Closes, locks, and marks the pull request as archived. - Only repository admins can archive pull requests. - Archived pull requests are hidden from non-admin users. - tags: - - pulls - operationId: pulls/archive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request - parameters: - - *338 - - *339 - - *581 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - delete: - summary: Unarchive a pull request - description: |- - Unarchives a pull request. Removes the archived flag from the pull request. - Does not automatically reopen or unlock the pull request. - Only repository admins can unarchive pull requests. - tags: - - pulls - operationId: pulls/unarchive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request - parameters: - - *338 - - *339 - - *581 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -100184,25 +100251,25 @@ paths: - *313 - *596 - allOf: - - *314 + - *318 - *596 - allOf: - - *315 + - *319 - *596 - allOf: - - *316 + - *320 - *596 - allOf: - - *317 + - *314 - *596 - allOf: - - *318 + - *315 - *596 - allOf: - - *319 + - *316 - *596 - allOf: - - *320 + - *317 - *596 examples: default: @@ -105543,6 +105610,7 @@ paths: - no_accessible_repos - server_error - only_non_semantic_fields_requested + - service_unavailable examples: default: summary: Hybrid search response @@ -105561,6 +105629,15 @@ paths: node_id: MDU6SXNzdWUzNTgwMg== number: 132 title: Line Number Indexes Beyond 20 Not Displayed + type: + id: 1 + node_id: IT_kwDNJr9H + name: Bug + description: An unexpected problem or behavior + color: red + created_at: '2023-10-09T13:30:49Z' + updated_at: '2024-05-30T18:20:53Z' + is_enabled: true user: login: Nick3C id: 90254 diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 62edeccf3..18dfa5cb2 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -27894,17 +27894,17 @@ } } }, - "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { "get": { - "summary": "Get Copilot users usage metrics for a specific day", - "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-users-one-day-usage-metrics", + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" }, "parameters": [ { @@ -28060,17 +28060,17 @@ } } }, - "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { - "summary": "Get Copilot users usage metrics", - "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "summary": "Get Copilot users usage metrics for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot user usage metrics report for a specific day. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the specified day, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. Reports are available starting from October 10, 2025, and historical data can be accessed for up to 1 year from the current date.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/copilot-users-usage-metrics", + "operationId": "copilot/copilot-users-one-day-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics-for-a-specific-day" }, "parameters": [ { @@ -28081,6 +28081,19 @@ "schema": { "type": "string" } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } } ], "responses": { @@ -28090,8 +28103,8 @@ "application/json": { "schema": { "type": "object", - "title": "Copilot Metrics 28 Day Report", - "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", "properties": { "download_links": { "type": "array", @@ -28099,23 +28112,17 @@ "type": "string", "format": "uri" }, - "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." - }, - "report_start_day": { - "type": "string", - "format": "date", - "description": "The start date of the report period in `YYYY-MM-DD` format." + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." }, - "report_end_day": { + "report_day": { "type": "string", "format": "date", - "description": "The end date of the report period in `YYYY-MM-DD` format." + "description": "The day of the report in `YYYY-MM-DD` format." } }, "required": [ "download_links", - "report_start_day", - "report_end_day" + "report_day" ] }, "examples": { @@ -28125,8 +28132,7 @@ "https://example.com/copilot-usage-report-1.json", "https://example.com/copilot-usage-report-2.json" ], - "report_start_day": "2025-07-01", - "report_end_day": "2025-07-28" + "report_day": "2025-07-01" } } } @@ -28220,17 +28226,17 @@ } } }, - "/enterprises/{enterprise}/copilot/policies/coding_agent": { - "put": { - "summary": "Set the coding agent policy for an enterprise", - "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "/enterprises/{enterprise}/copilot/metrics/reports/users-28-day/latest": { + "get": { + "summary": "Get Copilot users usage metrics", + "description": "Use this endpoint to retrieve download links for the latest 28-day enterprise users Copilot usage metrics report. The report provides detailed user-level usage data and engagement metrics for Copilot features across the enterprise.\n\nThe report contains user-specific metrics for the previous 28 days, including individual user engagement statistics, feature usage patterns, and adoption metrics broken down by user. This report allows authorized users to analyze Copilot usage at the user level to understand adoption patterns and identify opportunities for increased engagement.\n\nReports are generated daily and made available for download through signed URLs with a limited expiration time. The response includes download links to the report files, along with the specific date range covered by the report. The report covers a complete 28-day period ending on the most recent day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/set-enterprise-coding-agent-policy", + "operationId": "copilot/copilot-users-usage-metrics", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-users-usage-metrics" }, "parameters": [ { @@ -28243,46 +28249,58 @@ } } ], - "requestBody": { - "description": "The coding agent policy configuration", - "required": true, - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "policy_state": { - "type": "string", - "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", - "enum": [ - "enabled_for_all_orgs", - "disabled_for_all_orgs", - "enabled_for_selected_orgs", - "configured_by_org_admins" - ] - } + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 28 Day Report", + "description": "Links to download the latest Copilot usage metrics report for an enterprise/organization.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the latest Copilot usage metrics report for the enterprise/organization." + }, + "report_start_day": { + "type": "string", + "format": "date", + "description": "The start date of the report period in `YYYY-MM-DD` format." + }, + "report_end_day": { + "type": "string", + "format": "date", + "description": "The end date of the report period in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_start_day", + "report_end_day" + ] }, - "required": [ - "policy_state" - ] - }, - "examples": { - "default": { - "summary": "Enable coding agent for all organizations", - "value": { - "policy_state": "enabled_for_all_orgs" + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_start_day": "2025-07-01", + "report_end_day": "2025-07-28" + } } } } } - } - }, - "responses": { - "204": { - "description": "A header with no content is returned." }, - "400": { - "description": "Bad Request", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -28304,45 +28322,55 @@ } } } - }, - "application/scim+json": { + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { "schema": { - "title": "Scim Error", - "description": "Scim Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { - "type": [ - "string", - "null" - ] + "type": "string" }, "documentation_url": { - "type": [ - "string", - "null" - ] + "type": "string" }, - "detail": { - "type": [ - "string", - "null" - ] + "url": { + "type": "string" }, "status": { - "type": "integer" + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "scimType": { - "type": [ - "string", - "null" - ] + "documentation_url": { + "type": "string" }, - "schemas": { - "type": "array", - "items": { - "type": "string" - } + "url": { + "type": "string" + }, + "status": { + "type": "string" } } } @@ -28351,23 +28379,24 @@ } }, "x-github": { - "enabledForGitHubApps": false, + "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "copilot", - "subcategory": "copilot-coding-agent-management" + "subcategory": "copilot-usage-metrics" } } }, - "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { - "post": { - "summary": "Add organizations to the enterprise coding agent policy", - "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "/enterprises/{enterprise}/copilot/policies/coding_agent": { + "put": { + "summary": "Set the coding agent policy for an enterprise", + "description": "Sets the policy for Copilot cloud agent usage across an enterprise.\n\nEnterprise owners can configure whether Copilot cloud agent is enabled for all\norganizations, disabled for all organizations, configured by individual organization\nadmins, or enabled for selected organizations only.\n\nOnly enterprise owners can set the coding agent policy for their enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", "tags": [ "copilot" ], - "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", + "operationId": "copilot/set-enterprise-coding-agent-policy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#set-the-coding-agent-policy-for-an-enterprise" }, "parameters": [ { @@ -28381,63 +28410,200 @@ } ], "requestBody": { - "description": "The organizations to enable Copilot cloud agent for", + "description": "The coding agent policy configuration", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { - "organizations": { - "type": "array", - "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", - "items": { - "type": "string" - } - }, - "custom_properties": { - "type": "array", - "description": "List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.", - "items": { - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the custom property to filter by." - }, - "values": { - "type": "array", - "description": "The values of the custom property to match.", - "items": { - "type": "string" - } - } - }, - "required": [ - "property_name", - "values" - ] - } + "policy_state": { + "type": "string", + "description": "The policy state for Copilot cloud agent in the enterprise. Can be one of `enabled_for_all_orgs`, `disabled_for_all_orgs`, `enabled_for_selected_orgs`, or `configured_by_org_admins`.", + "enum": [ + "enabled_for_all_orgs", + "disabled_for_all_orgs", + "enabled_for_selected_orgs", + "configured_by_org_admins" + ] } - } + }, + "required": [ + "policy_state" + ] }, "examples": { "default": { - "summary": "Add organizations that match a login or have a custom property", + "summary": "Enable coding agent for all organizations", "value": { - "organizations": [ - "my-org-1", - "my-org-2" - ], - "custom_properties": [ - { - "property_name": "department", - "values": [ - "engineering", - "security" - ] - } - ] + "policy_state": "enabled_for_all_orgs" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "category": "copilot", + "subcategory": "copilot-coding-agent-management" + } + } + }, + "/enterprises/{enterprise}/copilot/policies/coding_agent/organizations": { + "post": { + "summary": "Add organizations to the enterprise coding agent policy", + "description": "Enables Copilot cloud agent for the specified organizations within the enterprise.\n\nThe enterprise's coding agent policy must be set to `enabled_for_selected_orgs` before\nusing this endpoint. Organizations can be specified by login or matched via custom properties.\n\nOnly organizations that have Copilot enabled and belong to the enterprise will be affected.\n\nOnly enterprise owners can add organizations to the coding agent policy.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `admin:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/add-organizations-to-enterprise-coding-agent-policy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-coding-agent-management#add-organizations-to-the-enterprise-coding-agent-policy" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "description": "The organizations to enable Copilot cloud agent for", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organizations": { + "type": "array", + "description": "List of organization logins within the enterprise to enable Copilot cloud agent for.", + "items": { + "type": "string" + } + }, + "custom_properties": { + "type": "array", + "description": "List of custom property filters to match organizations. Organizations matching any of the specified property name/value pairs will be included. This is a one-time operation, setting the property on an organization in the future will not automatically update its coding agent policy.", + "items": { + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the custom property to filter by." + }, + "values": { + "type": "array", + "description": "The values of the custom property to match.", + "items": { + "type": "string" + } + } + }, + "required": [ + "property_name", + "values" + ] + } + } + } + }, + "examples": { + "default": { + "summary": "Add organizations that match a login or have a custom property", + "value": { + "organizations": [ + "my-org-1", + "my-org-2" + ], + "custom_properties": [ + { + "property_name": "department", + "values": [ + "engineering", + "security" + ] + } + ] } } } @@ -37191,7 +37357,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -41708,7 +41874,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -64691,7 +64857,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -73280,7 +73446,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -77797,7 +77963,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -133659,7 +133825,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -134553,7 +134719,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -135559,7 +135725,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -136376,7 +136542,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -137390,7 +137556,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -137535,7 +137701,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -138009,7 +138175,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -138586,7 +138752,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -139164,7 +139330,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -139282,7 +139448,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -139474,7 +139640,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -139854,7 +140020,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -140029,7 +140195,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -140306,7 +140472,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -146381,6 +146547,175 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -155249,7 +155584,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -159766,7 +160101,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -176068,7 +176403,7 @@ "type": "array", "items": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -176281,7 +176616,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -176524,7 +176859,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -178147,7 +178482,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -213325,7 +213660,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -225344,7 +225679,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -250926,128 +251261,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -251200,6 +251413,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -253582,128 +253917,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -253856,6 +254069,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -255688,6 +256023,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -255809,159 +256297,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -258365,128 +258700,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -258639,6 +258852,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -410427,6 +410762,121 @@ } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -424163,7 +424613,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -428680,7 +429130,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -455941,6 +456391,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "labels", "description": "A list of comma separated label names. Example: `bug,ui,@high`", @@ -457256,7 +457715,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -461776,7 +462235,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -472468,7 +472927,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -478561,7 +479020,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -484450,7 +484909,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -489197,7 +489656,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -493702,7 +494161,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -497985,7 +498444,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -504658,7 +505117,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -509016,7 +509475,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -513470,7 +513929,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -517946,7 +518405,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -537059,7 +537518,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -542582,7 +543041,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -546962,7 +547421,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -551298,7 +551757,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -555751,7 +556210,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -570902,7 +571361,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -612554,366 +613013,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -645356,8 +645455,8 @@ { "allOf": [ { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", "type": "object", "required": [ "type" @@ -645366,22 +645465,50 @@ "type": { "type": "string", "enum": [ - "file_path_restriction" + "workflows" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_paths": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", + "description": "Workflows that must pass for this rule to pass.", "items": { - "type": "string" + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] } } }, "required": [ - "restricted_file_paths" + "workflows" ] } } @@ -645413,8 +645540,8 @@ { "allOf": [ { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", "type": "object", "required": [ "type" @@ -645423,21 +645550,56 @@ "type": { "type": "string", "enum": [ - "max_file_path_length" + "code_scanning" ] }, "parameters": { "type": "object", "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } } }, "required": [ - "max_file_path_length" + "code_scanning_tools" ] } } @@ -645469,8 +645631,8 @@ { "allOf": [ { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -645479,23 +645641,21 @@ "type": { "type": "string", "enum": [ - "file_extension_restriction" + "copilot_code_review" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." } - }, - "required": [ - "restricted_file_extensions" - ] + } } } }, @@ -645526,8 +645686,8 @@ { "allOf": [ { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", "type": "object", "required": [ "type" @@ -645536,21 +645696,22 @@ "type": { "type": "string", "enum": [ - "max_file_size" + "file_path_restriction" ] }, "parameters": { "type": "object", "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } }, "required": [ - "max_file_size" + "restricted_file_paths" ] } } @@ -645582,8 +645743,8 @@ { "allOf": [ { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -645592,50 +645753,21 @@ "type": { "type": "string", "enum": [ - "workflows" + "max_file_path_length" ] }, "parameters": { "type": "object", "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 } }, "required": [ - "workflows" + "max_file_path_length" ] } } @@ -645667,8 +645799,8 @@ { "allOf": [ { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -645677,56 +645809,22 @@ "type": { "type": "string", "enum": [ - "code_scanning" + "file_extension_restriction" ] }, "parameters": { "type": "object", "properties": { - "code_scanning_tools": { + "restricted_file_extensions": { "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", + "description": "The file extensions that are restricted from being pushed to the commit graph.", "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] + "type": "string" } } }, "required": [ - "code_scanning_tools" + "restricted_file_extensions" ] } } @@ -645758,8 +645856,8 @@ { "allOf": [ { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -645768,21 +645866,22 @@ "type": { "type": "string", "enum": [ - "copilot_code_review" + "max_file_size" ] }, "parameters": { "type": "object", "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 } - } + }, + "required": [ + "max_file_size" + ] } } }, @@ -646971,128 +647070,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -647245,6 +647222,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -648121,6 +648220,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -648242,159 +648494,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -649484,128 +649583,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -649758,6 +649735,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -651609,6 +651708,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -651730,159 +651982,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -652774,128 +652873,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -653048,6 +653025,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -654133,6 +654232,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -654254,159 +654506,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -697657,7 +697756,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -699189,7 +699288,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -699214,6 +699314,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, @@ -743518,7 +743628,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -780459,7 +780569,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -801082,7 +801192,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -805599,7 +805709,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -814426,7 +814536,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -818943,7 +819053,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -827780,7 +827890,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -832297,7 +832407,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -852660,7 +852770,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -869481,7 +869591,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -873998,7 +874108,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -882821,7 +882931,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -887338,7 +887448,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1101370,7 +1101480,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1105910,7 +1106020,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1110474,7 +1110584,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1115022,7 +1115132,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1119572,7 +1119682,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1123275,7 +1123385,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1127303,7 +1127413,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1134332,7 +1134442,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1138360,7 +1138470,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1145389,7 +1145499,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1150488,7 +1150598,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1156446,7 +1156556,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1161545,7 +1161655,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1168660,7 +1168770,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1173071,7 +1173181,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1177690,7 +1177800,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1182113,7 +1182223,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1186713,7 +1186823,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1191167,7 +1191277,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1195734,7 +1195844,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1200221,7 +1200331,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1204696,7 +1204806,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1209099,7 +1209209,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1213669,7 +1213779,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1215758,7 +1215868,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1221085,7 +1221195,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1225621,7 +1225731,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1229776,7 +1229886,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1232918,7 +1233028,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1237324,7 +1237434,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1237526,7 +1237636,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1241899,7 +1242009,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1246305,7 +1246415,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1250778,7 +1250888,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1255154,7 +1255264,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1259559,7 +1259669,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1259761,7 +1259871,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1606524,128 +1606634,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1606798,6 +1606786,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1609866,6 +1609976,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1609987,159 +1610250,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1613208,128 +1613318,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1613482,6 +1613470,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1614282,6 +1614392,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1614403,159 +1614666,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1615184,128 +1615294,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1615458,6 +1615446,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1616089,128 +1616199,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1616363,6 +1616351,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] }, @@ -1691204,7 +1691314,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1696303,7 +1696413,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1702262,7 +1702372,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1707361,7 +1707471,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1713320,7 +1713430,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1718419,7 +1718529,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1724378,7 +1724488,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1729477,7 +1729587,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 3cefda5dc..b09ac051b 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -12148,6 +12148,42 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot enterprise user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day + parameters: + - *38 + - *54 + responses: + '200': + description: Response + content: + application/json: + schema: *55 + examples: + default: *56 + '500': *53 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day @@ -15324,7 +15360,9 @@ paths: format: uri type: &243 title: Issue Type - description: The type of issue. + description: The type assigned to the issue. This + is only present for issues in repositories where + issue types are supported. type: - object - 'null' @@ -34791,6 +34829,8 @@ paths: Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response. tags: - copilot-spaces operationId: copilot-spaces/list-for-org @@ -35123,6 +35163,8 @@ paths: Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources. tags: - copilot-spaces operationId: copilot-spaces/create-for-org @@ -35313,6 +35355,8 @@ paths: Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-for-org @@ -35349,6 +35393,8 @@ paths: Organization members with appropriate permissions can update Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated. tags: - copilot-spaces operationId: copilot-spaces/update-for-org @@ -35481,6 +35527,8 @@ paths: Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-for-org @@ -35515,6 +35563,8 @@ paths: **Note:** Team collaborators listed here are teams that are defined in the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-collaborators-for-org @@ -35707,6 +35757,8 @@ paths: When adding teams as collaborators, they must be defined in the organization. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/add-collaborator-for-org @@ -35836,6 +35888,8 @@ paths: Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/update-collaborator-for-org @@ -35966,6 +36020,8 @@ paths: Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/remove-collaborator-for-org @@ -36013,6 +36069,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-resources-for-org @@ -36121,6 +36179,8 @@ paths: For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created. tags: - copilot-spaces operationId: copilot-spaces/create-resource-for-org @@ -36226,6 +36286,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-resource-for-org @@ -36276,6 +36338,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated. tags: - copilot-spaces operationId: copilot-spaces/update-resource-for-org @@ -36344,6 +36408,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-resource-for-org @@ -38033,6 +38099,45 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot organization user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day + parameters: + - *74 + - *54 + responses: + '200': + description: Response + content: + application/json: + schema: *55 + examples: + default: *56 + '204': *59 + '500': *53 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot organization users usage metrics for a specific day @@ -52140,103 +52245,6 @@ paths: required: - operator - pattern - - &314 - title: file_path_restriction - description: Prevent commits that include changes in specified - file and folder paths from being pushed to the commit - graph. This includes absolute paths that contain file - names. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_paths - - &315 - title: max_file_path_length - description: Prevent commits that include file paths that - exceed the specified character limit from being pushed - to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed - in file paths. - minimum: 1 - maximum: 32767 - required: - - max_file_path_length - - &316 - title: file_extension_restriction - description: Prevent commits that include files with specified - file extensions from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - &317 - title: max_file_size - description: Prevent commits with individual files that - exceed the specified limit from being pushed to the commit - graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. - This limit does not apply to Git Large File Storage - (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - &318 title: workflows description: Require all changes made to a targeted branch @@ -52374,6 +52382,103 @@ paths: type: boolean description: Copilot automatically reviews each new push to the pull request. + - &314 + title: file_path_restriction + description: Prevent commits that include changes in specified + file and folder paths from being pushed to the commit + graph. This includes absolute paths that contain file + names. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_paths + - &315 + title: max_file_path_length + description: Prevent commits that include file paths that + exceed the specified character limit from being pushed + to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed + in file paths. + minimum: 1 + maximum: 32767 + required: + - max_file_path_length + - &316 + title: file_extension_restriction + description: Prevent commits that include files with specified + file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - &317 + title: max_file_size + description: Prevent commits with individual files that + exceed the specified limit from being pushed to the commit + graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. + This limit does not apply to Git Large File Storage + (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size created_at: type: string format: date-time @@ -81430,6 +81535,9 @@ paths: content: application/json: schema: *3 + '400': *14 + '500': *53 + '503': *114 x-github: githubCloudOnly: false category: dependency-graph @@ -87958,6 +88066,20 @@ paths: required: false schema: type: string + - name: issue_field_values + description: |- + A comma-separated list of issue field filters in `field_slug:value` format. + Only issues matching all specified field values are returned. + Requires issue fields to be enabled for the repository. Issue fields are + not available for user-owned repositories, and field availability for + organization-owned public repositories depends on the organization's + visibility settings. For example, `priority:Urgent,severity:High` filters + issues where the `priority` field is `Urgent` AND the `severity` field is + `High`. + in: query + required: false + schema: + type: string - *246 - name: sort description: What to sort results by. @@ -97355,61 +97477,6 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": - put: - summary: Archive a pull request - description: |- - Archives a pull request. Closes, locks, and marks the pull request as archived. - Only repository admins can archive pull requests. - Archived pull requests are hidden from non-admin users. - tags: - - pulls - operationId: pulls/archive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#archive-a-pull-request - parameters: - - *338 - - *339 - - *581 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - delete: - summary: Unarchive a pull request - description: |- - Unarchives a pull request. Removes the archived flag from the pull request. - Does not automatically reopen or unlock the pull request. - Only repository admins can unarchive pull requests. - tags: - - pulls - operationId: pulls/unarchive - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/pulls/pulls#unarchive-a-pull-request - parameters: - - *338 - - *339 - - *581 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -101571,25 +101638,25 @@ paths: - *313 - *596 - allOf: - - *314 + - *318 - *596 - allOf: - - *315 + - *319 - *596 - allOf: - - *316 + - *320 - *596 - allOf: - - *317 + - *314 - *596 - allOf: - - *318 + - *315 - *596 - allOf: - - *319 + - *316 - *596 - allOf: - - *320 + - *317 - *596 examples: default: @@ -106986,6 +107053,7 @@ paths: - no_accessible_repos - server_error - only_non_semantic_fields_requested + - service_unavailable examples: default: summary: Hybrid search response @@ -107004,6 +107072,15 @@ paths: node_id: MDU6SXNzdWUzNTgwMg== number: 132 title: Line Number Indexes Beyond 20 Not Displayed + type: + id: 1 + node_id: IT_kwDNJr9H + name: Bug + description: An unexpected problem or behavior + color: red + created_at: '2023-10-09T13:30:49Z' + updated_at: '2024-05-30T18:20:53Z' + is_enabled: true user: login: Nick3C id: 90254 diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index 4760d2112..b05cc288f 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -52621,6 +52621,172 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot users usage metrics for a specific day", @@ -68525,128 +68691,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -68799,6 +68843,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -69991,6 +70157,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -70112,159 +70431,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -73182,128 +73348,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -73456,6 +73500,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -89318,7 +89484,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -93672,7 +93838,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -116130,7 +116296,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -124556,7 +124722,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -128910,7 +129076,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -183776,7 +183942,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -184670,7 +184836,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -185676,7 +185842,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -186493,7 +186659,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -187507,7 +187673,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -187652,7 +187818,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -188126,7 +188292,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -188703,7 +188869,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -189281,7 +189447,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -189399,7 +189565,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -189591,7 +189757,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -189971,7 +190137,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -190146,7 +190312,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -190423,7 +190589,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -196499,6 +196665,175 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -210066,7 +210401,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -214420,7 +214755,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -231061,7 +231396,7 @@ "type": "array", "items": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -231274,7 +231609,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -231517,7 +231852,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -233140,7 +233475,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -266621,7 +266956,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -278188,7 +278523,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -302985,128 +303320,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -303259,6 +303472,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -305645,128 +305980,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -305919,6 +306132,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -307753,6 +308088,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -307874,159 +308362,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -310434,128 +310769,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -310708,6 +310921,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -464327,6 +464662,121 @@ } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -482021,7 +482471,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -486375,7 +486825,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -513171,6 +513621,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "labels", "description": "A list of comma separated label names. Example: `bug,ui,@high`", @@ -514486,7 +514945,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -518843,7 +519302,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -529341,7 +529800,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -535271,7 +535730,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -540997,7 +541456,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -545557,7 +546016,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -549868,7 +550327,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -553976,7 +554435,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -560474,7 +560933,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -564669,7 +565128,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -568948,7 +569407,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -573249,7 +573708,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -592199,7 +592658,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -597547,7 +598006,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -601752,7 +602211,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -605925,7 +606384,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -610203,7 +610662,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -625179,7 +625638,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -665488,366 +665947,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -697692,8 +697791,8 @@ { "allOf": [ { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", "type": "object", "required": [ "type" @@ -697702,22 +697801,50 @@ "type": { "type": "string", "enum": [ - "file_path_restriction" + "workflows" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_paths": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", + "description": "Workflows that must pass for this rule to pass.", "items": { - "type": "string" + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] } } }, "required": [ - "restricted_file_paths" + "workflows" ] } } @@ -697749,8 +697876,8 @@ { "allOf": [ { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", "type": "object", "required": [ "type" @@ -697759,21 +697886,56 @@ "type": { "type": "string", "enum": [ - "max_file_path_length" + "code_scanning" ] }, "parameters": { "type": "object", "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } } }, "required": [ - "max_file_path_length" + "code_scanning_tools" ] } } @@ -697805,8 +697967,8 @@ { "allOf": [ { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -697815,23 +697977,21 @@ "type": { "type": "string", "enum": [ - "file_extension_restriction" + "copilot_code_review" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." } - }, - "required": [ - "restricted_file_extensions" - ] + } } } }, @@ -697862,8 +698022,8 @@ { "allOf": [ { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", "type": "object", "required": [ "type" @@ -697872,21 +698032,22 @@ "type": { "type": "string", "enum": [ - "max_file_size" + "file_path_restriction" ] }, "parameters": { "type": "object", "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } }, "required": [ - "max_file_size" + "restricted_file_paths" ] } } @@ -697918,8 +698079,8 @@ { "allOf": [ { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -697928,50 +698089,21 @@ "type": { "type": "string", "enum": [ - "workflows" + "max_file_path_length" ] }, "parameters": { "type": "object", "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 } }, "required": [ - "workflows" + "max_file_path_length" ] } } @@ -698003,8 +698135,8 @@ { "allOf": [ { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -698013,56 +698145,22 @@ "type": { "type": "string", "enum": [ - "code_scanning" + "file_extension_restriction" ] }, "parameters": { "type": "object", "properties": { - "code_scanning_tools": { + "restricted_file_extensions": { "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", + "description": "The file extensions that are restricted from being pushed to the commit graph.", "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] + "type": "string" } } }, "required": [ - "code_scanning_tools" + "restricted_file_extensions" ] } } @@ -698094,8 +698192,8 @@ { "allOf": [ { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -698104,21 +698202,22 @@ "type": { "type": "string", "enum": [ - "copilot_code_review" + "max_file_size" ] }, "parameters": { "type": "object", "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 } - } + }, + "required": [ + "max_file_size" + ] } } }, @@ -699309,128 +699408,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -699583,6 +699560,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -700461,6 +700560,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -700582,159 +700834,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -701826,128 +701925,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -702100,6 +702077,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -703953,6 +704052,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -704074,159 +704326,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -705120,128 +705219,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -705394,6 +705371,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -706481,6 +706580,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -706602,159 +706854,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -760431,7 +760530,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -761929,7 +762028,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -761954,6 +762054,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, @@ -806252,7 +806362,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -839633,7 +839743,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -859749,7 +859859,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -864103,7 +864213,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -872767,7 +872877,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -877121,7 +877231,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -885795,7 +885905,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -890149,7 +890259,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -910333,7 +910443,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -926702,7 +926812,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -931056,7 +931166,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -939716,7 +939826,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -944070,7 +944180,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1203957,7 +1204067,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1208472,7 +1208582,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1213011,7 +1213121,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1217534,7 +1217644,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1222059,7 +1222169,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1225737,7 +1225847,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1229602,7 +1229712,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1236340,7 +1236450,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1240205,7 +1240315,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1246943,7 +1247053,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1251776,7 +1251886,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1257546,7 +1257656,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1262379,7 +1262489,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1269306,7 +1269416,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1273692,7 +1273802,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1278286,7 +1278396,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1282684,7 +1282794,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1287259,7 +1287369,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1291688,7 +1291798,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1296230,7 +1296340,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1300692,7 +1300802,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1305142,7 +1305252,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1309520,7 +1309630,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1314065,7 +1314175,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1316154,7 +1316264,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1321456,7 +1321566,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1325967,7 +1326077,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1330097,7 +1330207,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1333239,7 +1333349,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1337620,7 +1337730,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1337822,7 +1337932,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1342170,7 +1342280,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1346551,7 +1346661,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1350999,7 +1351109,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1355350,7 +1355460,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1359730,7 +1359840,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1359932,7 +1360042,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1703503,128 +1703613,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1703777,6 +1703765,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1706822,6 +1706932,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1706943,159 +1707206,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1710141,128 +1710251,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1710415,6 +1710403,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1711215,6 +1711325,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1711336,159 +1711599,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1712117,128 +1712227,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1712391,6 +1712379,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1713022,128 +1713132,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1713296,6 +1713284,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] }, @@ -1787093,7 +1787203,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1791926,7 +1792036,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1797697,7 +1797807,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1802530,7 +1802640,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1808301,7 +1808411,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1813134,7 +1813244,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1818905,7 +1819015,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1823738,7 +1823848,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 21e8eb289..8635aaa9b 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -20661,6 +20661,42 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot enterprise user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Enterprise owners, billing managers, and authorized users with fine-grained "View Enterprise Copilot Metrics" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. + tags: + - copilot + operationId: copilot/copilot-enterprise-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day + parameters: + - *39 + - *121 + responses: + '200': + description: Response + content: + application/json: + schema: *122 + examples: + default: *123 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot users usage metrics for a specific day @@ -25323,7 +25359,7 @@ paths: required: - operator - pattern - - &180 + - &183 title: file_path_restriction description: Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. @@ -25347,7 +25383,7 @@ paths: type: string required: - restricted_file_paths - - &181 + - &184 title: max_file_path_length description: Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit @@ -25371,7 +25407,7 @@ paths: maximum: 32767 required: - max_file_path_length - - &182 + - &185 title: file_extension_restriction description: Prevent commits that include files with specified file extensions from being pushed to the commit graph. @@ -25394,7 +25430,7 @@ paths: type: string required: - restricted_file_extensions - - &183 + - &186 title: max_file_size description: Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph. @@ -25418,7 +25454,7 @@ paths: maximum: 100 required: - max_file_size - - &184 + - &180 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -25467,7 +25503,7 @@ paths: - repository_id required: - workflows - - &185 + - &181 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning @@ -25527,7 +25563,7 @@ paths: - tool required: - code_scanning_tools - - &186 + - &182 title: copilot_code_review description: Request Copilot code review for new pull requests automatically if the author has access to Copilot code review @@ -31187,7 +31223,9 @@ paths: format: uri type: &387 title: Issue Type - description: The type of issue. + description: The type assigned to the issue. This + is only present for issues in repositories where + issue types are supported. type: - object - 'null' @@ -48397,6 +48435,8 @@ paths: Only Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response. tags: - copilot-spaces operationId: copilot-spaces/list-for-org @@ -48729,6 +48769,8 @@ paths: Organization members with appropriate permissions can create Copilot Spaces to be shared within their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources. tags: - copilot-spaces operationId: copilot-spaces/create-for-org @@ -48919,6 +48961,8 @@ paths: Internal Spaces require the authenticated user to be a member of the organization or have been granted read permissions. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-for-org @@ -48955,6 +48999,8 @@ paths: Organization members with appropriate permissions can update Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated. tags: - copilot-spaces operationId: copilot-spaces/update-for-org @@ -49087,6 +49133,8 @@ paths: Organization members with appropriate permissions can delete Copilot Spaces owned by their organization. OAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-for-org @@ -49121,6 +49169,8 @@ paths: **Note:** Team collaborators listed here are teams that are defined in the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-collaborators-for-org @@ -49313,6 +49363,8 @@ paths: When adding teams as collaborators, they must be defined in the organization. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/add-collaborator-for-org @@ -49442,6 +49494,8 @@ paths: Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/update-collaborator-for-org @@ -49572,6 +49626,8 @@ paths: Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/remove-collaborator-for-org @@ -49619,6 +49675,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/list-resources-for-org @@ -49727,6 +49785,8 @@ paths: For `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created. tags: - copilot-spaces operationId: copilot-spaces/create-resource-for-org @@ -49832,6 +49892,8 @@ paths: The authenticated user must have appropriate permissions to view the space. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/get-resource-for-org @@ -49882,6 +49944,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated. tags: - copilot-spaces operationId: copilot-spaces/update-resource-for-org @@ -49950,6 +50014,8 @@ paths: The authenticated user must have write permissions on the space. OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. + + Fine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space. tags: - copilot-spaces operationId: copilot-spaces/delete-resource-for-org @@ -51074,6 +51140,45 @@ paths: enabledForGitHubApps: true category: copilot subcategory: copilot-usage-metrics + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": + get: + summary: Get Copilot organization user-teams report for a specific day + description: |- + Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair. + + The report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time. + + The response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed. + + Organization owners and authorized users with fine-grained "View Organization Copilot Metrics" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. + + For more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations). + tags: + - copilot + operationId: copilot/copilot-organization-user-teams-one-day-report + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day + parameters: + - *87 + - *121 + responses: + '200': + description: Response + content: + application/json: + schema: *122 + examples: + default: *123 + '204': *126 + '500': *38 + '403': *27 + '404': *6 + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-usage-metrics "/orgs/{org}/copilot/metrics/reports/users-1-day": get: summary: Get Copilot organization users usage metrics for a specific day @@ -65943,13 +66048,13 @@ paths: - *177 - *178 - *179 - - *180 - - *181 - - *182 - *183 - *184 - *185 - *186 + - *180 + - *181 + - *182 required: - name - enforcement @@ -94248,6 +94353,9 @@ paths: content: application/json: schema: *3 + '400': *14 + '500': *38 + '503': *192 x-github: githubCloudOnly: false category: dependency-graph @@ -101432,6 +101540,20 @@ paths: required: false schema: type: string + - name: issue_field_values + description: |- + A comma-separated list of issue field filters in `field_slug:value` format. + Only issues matching all specified field values are returned. + Requires issue fields to be enabled for the repository. Issue fields are + not available for user-owned repositories, and field availability for + organization-owned public repositories depends on the organization's + visibility settings. For example, `priority:Urgent,severity:High` filters + issues where the `priority` field is `Urgent` AND the `severity` field is + `High`. + in: query + required: false + schema: + type: string - *390 - name: sort description: What to sort results by. @@ -110738,61 +110860,6 @@ paths: enabledForGitHubApps: true category: pulls subcategory: pulls - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": - put: - summary: Archive a pull request - description: |- - Archives a pull request. Closes, locks, and marks the pull request as archived. - Only repository admins can archive pull requests. - Archived pull requests are hidden from non-admin users. - tags: - - pulls - operationId: pulls/archive - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request - parameters: - - *473 - - *474 - - *708 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls - delete: - summary: Unarchive a pull request - description: |- - Unarchives a pull request. Removes the archived flag from the pull request. - Does not automatically reopen or unlock the pull request. - Only repository admins can unarchive pull requests. - tags: - - pulls - operationId: pulls/unarchive - externalDocs: - description: API method documentation - url: https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request - parameters: - - *473 - - *474 - - *708 - responses: - '204': - description: Response - '403': *27 - '404': *6 - '422': *15 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: pulls - subcategory: pulls "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": post: summary: Create a codespace from a pull request @@ -122420,6 +122487,7 @@ paths: - no_accessible_repos - server_error - only_non_semantic_fields_requested + - service_unavailable examples: default: summary: Hybrid search response @@ -122438,6 +122506,15 @@ paths: node_id: MDU6SXNzdWUzNTgwMg== number: 132 title: Line Number Indexes Beyond 20 Not Displayed + type: + id: 1 + node_id: IT_kwDNJr9H + name: Bug + description: An unexpected problem or behavior + color: red + created_at: '2023-10-09T13:30:49Z' + updated_at: '2024-05-30T18:20:53Z' + is_enabled: true user: login: Nick3C id: 90254 diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json index 28d27ab36..da129a559 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -52488,6 +52488,172 @@ } } }, + "/enterprises/{enterprise}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot enterprise user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot enterprise user-teams report for a specific day. The report provides user-team join data for Copilot across the enterprise, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing enterprise user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nEnterprise owners, billing managers, and authorized users with fine-grained \"View Enterprise Copilot Metrics\" permission can retrieve Copilot metrics reports for the enterprise. OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-enterprise-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-enterprise-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/enterprises/{enterprise}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot users usage metrics for a specific day", @@ -68364,128 +68530,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -68638,6 +68682,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -69830,6 +69996,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -69951,159 +70270,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -73021,128 +73187,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -73295,6 +73339,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -88987,7 +89153,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -93151,7 +93317,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -112263,7 +112429,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -120499,7 +120665,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -124663,7 +124829,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -179171,7 +179337,7 @@ "/orgs/{org}/copilot-spaces": { "get": { "summary": "List organization Copilot Spaces", - "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists Copilot Spaces owned by an organization. The authenticated user must have read access to the organization's Copilot Spaces.\n\nOnly Spaces that are readable by the authenticated user are returned. This includes public Spaces and internal Spaces if the user is a member of the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in a space; spaces with inaccessible resources are omitted from the response.", "tags": [ "copilot-spaces" ], @@ -180065,7 +180231,7 @@ }, "post": { "summary": "Create an organization Copilot Space", - "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Creates a new Copilot Space owned by an organization. The authenticated user must have permissions to create spaces in the organization.\n\nOrganization members with appropriate permissions can create Copilot Spaces to be shared within their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by the submitted resources.", "tags": [ "copilot-spaces" ], @@ -181071,7 +181237,7 @@ "/orgs/{org}/copilot-spaces/{space_number}": { "get": { "summary": "Get an organization Copilot Space", - "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets details about a specific Copilot Space owned by an organization. The authenticated user must have read access to the Space.\n\nInternal Spaces require the authenticated user to be a member of the organization or have been granted read permissions.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -181888,7 +182054,7 @@ }, "put": { "summary": "Set an organization Copilot Space", - "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Updates a Copilot Space owned by an organization. The authenticated user must have permissions to update spaces in the organization.\n\nOrganization members with appropriate permissions can update Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including any being added or updated.", "tags": [ "copilot-spaces" ], @@ -182902,7 +183068,7 @@ }, "delete": { "summary": "Delete an organization Copilot Space", - "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.", + "description": "Deletes a Copilot Space owned by an organization. The authenticated user must have permissions to delete spaces in the organization.\n\n**Warning:** This action is permanent and cannot be undone. Deleting a Copilot Space will remove all associated resources and configurations.\n\nOrganization members with appropriate permissions can delete Copilot Spaces owned by their organization.\n\nOAuth app tokens and personal access tokens (classic) need both the `read:org` and `repo` scopes to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -183047,7 +183213,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators": { "get": { "summary": "List collaborators for an organization Copilot Space", - "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all collaborators for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to view collaborators.\n\nEach collaborator entry specifies which user or team has access to the space and at what level (reader, writer, or admin). The space owner (organization) is excluded from this list.\n\n**Note:** Team collaborators listed here are teams that are defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -183521,7 +183687,7 @@ }, "post": { "summary": "Add a collaborator to an organization Copilot Space", - "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Adds a collaborator (user or team) to a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\n**Note:** When adding users as collaborators, they must already be members of the organization.\nWhen adding teams as collaborators, they must be defined in the organization.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -184098,7 +184264,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/collaborators/{actor_type}/{actor_identifier}": { "put": { "summary": "Set a collaborator role for an organization Copilot Space", - "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the role of a collaborator for a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -184676,7 +184842,7 @@ }, "delete": { "summary": "Remove a collaborator from an organization Copilot Space", - "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Removes a collaborator from a specific Copilot Space owned by an organization. The authenticated user must have appropriate permissions to manage collaborators.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -184794,7 +184960,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources": { "get": { "summary": "List resources for an organization Copilot Space", - "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Lists all resources attached to a specific Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -184986,7 +185152,7 @@ }, "post": { "summary": "Create a resource for an organization Copilot Space", - "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Creates a new resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nThe following resource types are supported: `repository`, `github_file`, `free_text`, `github_issue`, `github_pull_request`.\nThe `uploaded_text_file` and `media_content` types are not supported via this endpoint.\n\nFor `github_file` resources, if a resource with the same repository, file path, and SHA already exists, the existing resource is returned with a `200` status.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being created.", "tags": [ "copilot-spaces" ], @@ -185366,7 +185532,7 @@ "/orgs/{org}/copilot-spaces/{space_number}/resources/{space_resource_id}": { "get": { "summary": "Get a resource for an organization Copilot Space", - "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "description": "Gets a specific resource attached to a Copilot Space owned by an organization.\nThe authenticated user must have appropriate permissions to view the space.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -185541,7 +185707,7 @@ }, "put": { "summary": "Set a resource for an organization Copilot Space", - "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Updates the metadata of a resource in a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space, including the resource being updated.", "tags": [ "copilot-spaces" ], @@ -185818,7 +185984,7 @@ }, "delete": { "summary": "Delete a resource from an organization Copilot Space", - "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.", + "description": "Deletes a resource from a specific Copilot Space owned by an organization.\nThe authenticated user must have write permissions on the space.\n\nOAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint.\n\nFine-grained tokens and GitHub App user access tokens must have been granted access to the organization that owns the space. They must also have been granted access to every repository referenced by resources in the space.", "tags": [ "copilot-spaces" ], @@ -191891,6 +192057,175 @@ } } }, + "/orgs/{org}/copilot/metrics/reports/user-teams-1-day": { + "get": { + "summary": "Get Copilot organization user-teams report for a specific day", + "description": "Use this endpoint to retrieve download links for the Copilot organization user-teams report for a specific day. The report provides user-team join data for Copilot across the organization, with one entry per user-team pair.\n\nThe report contains user-team membership data for the specified day, enabling consumers to join with the existing organization user reports to compute team-level usage metrics. Reports are generated daily and made available for download through signed URLs with a limited expiration time.\n\nThe response includes download links to the report files, along with the specific date of the report. The report covers a complete day for which data has been processed.\n\nOrganization owners and authorized users with fine-grained \"View Organization Copilot Metrics\" permission can retrieve Copilot metrics reports for the organization. OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.\n\nFor more information about organization metrics attribution, see [How are metrics attributed across organizations](https://docs.github.com/enterprise-cloud@latest/copilot/concepts/copilot-metrics#how-are-metrics-attributed-across-organizations).", + "tags": [ + "copilot" + ], + "operationId": "copilot/copilot-organization-user-teams-one-day-report", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/copilot/copilot-usage-metrics#get-copilot-organization-user-teams-report-for-a-specific-day" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "day", + "description": "The day to request data for, in `YYYY-MM-DD` format.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "format": "date", + "examples": [ + "2025-10-13" + ] + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "object", + "title": "Copilot Metrics 1 Day Report", + "description": "Links to download the Copilot usage metrics report for an enterprise/organization for a specific day.", + "properties": { + "download_links": { + "type": "array", + "items": { + "type": "string", + "format": "uri" + }, + "description": "The URLs to download the Copilot usage metrics report for the enterprise/organization for the specified day." + }, + "report_day": { + "type": "string", + "format": "date", + "description": "The day of the report in `YYYY-MM-DD` format." + } + }, + "required": [ + "download_links", + "report_day" + ] + }, + "examples": { + "default": { + "value": { + "download_links": [ + "https://example.com/copilot-usage-report-1.json", + "https://example.com/copilot-usage-report-2.json" + ], + "report_day": "2025-07-01" + } + } + } + } + } + }, + "204": { + "description": "A header with no content is returned." + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, "/orgs/{org}/copilot/metrics/reports/users-1-day": { "get": { "summary": "Get Copilot organization users usage metrics for a specific day", @@ -205247,7 +205582,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -209411,7 +209746,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -226032,7 +226367,7 @@ "type": "array", "items": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -226245,7 +226580,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -226488,7 +226823,7 @@ "application/json": { "schema": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -227941,7 +228276,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -259594,7 +259929,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -270747,7 +271082,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -295302,128 +295637,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -295576,6 +295789,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -297962,128 +298297,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -298236,6 +298449,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -300070,6 +300405,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -300191,159 +300679,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -302751,128 +303086,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -303025,6 +303238,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -455990,6 +456325,121 @@ } } } + }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + }, + "application/scim+json": { + "schema": { + "title": "Scim Error", + "description": "Scim Error", + "type": "object", + "properties": { + "message": { + "type": [ + "string", + "null" + ] + }, + "documentation_url": { + "type": [ + "string", + "null" + ] + }, + "detail": { + "type": [ + "string", + "null" + ] + }, + "status": { + "type": "integer" + }, + "scimType": { + "type": [ + "string", + "null" + ] + }, + "schemas": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { @@ -473514,7 +473964,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -477678,7 +478128,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -504375,6 +504825,15 @@ "type": "string" } }, + { + "name": "issue_field_values", + "description": "A comma-separated list of issue field filters in `field_slug:value` format.\nOnly issues matching all specified field values are returned.\nRequires issue fields to be enabled for the repository. Issue fields are\nnot available for user-owned repositories, and field availability for\norganization-owned public repositories depends on the organization's\nvisibility settings. For example, `priority:Urgent,severity:High` filters\nissues where the `priority` field is `Urgent` AND the `severity` field is\n`High`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, { "name": "labels", "description": "A list of comma separated label names. Example: `bug,ui,@high`", @@ -505520,7 +505979,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -509680,7 +510139,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -519968,7 +520427,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -525708,7 +526167,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -531244,7 +531703,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -535567,7 +536026,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -539668,7 +540127,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -543566,7 +544025,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -549854,7 +550313,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -553859,7 +554318,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -557928,7 +558387,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -562019,7 +562478,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -580779,7 +581238,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -585917,7 +586376,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -589912,7 +590371,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -593895,7 +594354,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -597963,7 +598422,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -612729,7 +613188,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -652056,366 +652515,6 @@ } } }, - "/repos/{owner}/{repo}/pulls/{pull_number}/archive": { - "put": { - "summary": "Archive a pull request", - "description": "Archives a pull request. Closes, locks, and marks the pull request as archived.\nOnly repository admins can archive pull requests.\nArchived pull requests are hidden from non-admin users.", - "tags": [ - "pulls" - ], - "operationId": "pulls/archive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#archive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - }, - "delete": { - "summary": "Unarchive a pull request", - "description": "Unarchives a pull request. Removes the archived flag from the pull request.\nDoes not automatically reopen or unlock the pull request.\nOnly repository admins can unarchive pull requests.", - "tags": [ - "pulls" - ], - "operationId": "pulls/unarchive", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls#unarchive-a-pull-request" - }, - "parameters": [ - { - "name": "owner", - "description": "The account owner of the repository. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "description": "The name of the repository without the `.git` extension. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "pull_number", - "description": "The number that identifies the pull request.", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation failed, or the endpoint has been spammed.", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": [ - "string", - "null" - ] - }, - { - "type": [ - "integer", - "null" - ] - }, - { - "type": [ - "array", - "null" - ], - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "pulls", - "subcategory": "pulls" - } - } - }, "/repos/{owner}/{repo}/pulls/{pull_number}/codespaces": { "post": { "summary": "Create a codespace from a pull request", @@ -683785,8 +683884,8 @@ { "allOf": [ { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", "type": "object", "required": [ "type" @@ -683795,22 +683894,50 @@ "type": { "type": "string", "enum": [ - "file_path_restriction" + "workflows" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_paths": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", + "description": "Workflows that must pass for this rule to pass.", "items": { - "type": "string" + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] } } }, "required": [ - "restricted_file_paths" + "workflows" ] } } @@ -683842,8 +683969,8 @@ { "allOf": [ { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", "type": "object", "required": [ "type" @@ -683852,21 +683979,56 @@ "type": { "type": "string", "enum": [ - "max_file_path_length" + "code_scanning" ] }, "parameters": { "type": "object", "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } } }, "required": [ - "max_file_path_length" + "code_scanning_tools" ] } } @@ -683898,8 +684060,8 @@ { "allOf": [ { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": [ "type" @@ -683908,23 +684070,21 @@ "type": { "type": "string", "enum": [ - "file_extension_restriction" + "copilot_code_review" ] }, "parameters": { "type": "object", "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." } - }, - "required": [ - "restricted_file_extensions" - ] + } } } }, @@ -683955,8 +684115,8 @@ { "allOf": [ { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", "type": "object", "required": [ "type" @@ -683965,21 +684125,22 @@ "type": { "type": "string", "enum": [ - "max_file_size" + "file_path_restriction" ] }, "parameters": { "type": "object", "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } } }, "required": [ - "max_file_size" + "restricted_file_paths" ] } } @@ -684011,8 +684172,8 @@ { "allOf": [ { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -684021,50 +684182,21 @@ "type": { "type": "string", "enum": [ - "workflows" + "max_file_path_length" ] }, "parameters": { "type": "object", "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 } }, "required": [ - "workflows" + "max_file_path_length" ] } } @@ -684096,8 +684228,8 @@ { "allOf": [ { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -684106,56 +684238,22 @@ "type": { "type": "string", "enum": [ - "code_scanning" + "file_extension_restriction" ] }, "parameters": { "type": "object", "properties": { - "code_scanning_tools": { + "restricted_file_extensions": { "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", + "description": "The file extensions that are restricted from being pushed to the commit graph.", "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] + "type": "string" } } }, "required": [ - "code_scanning_tools" + "restricted_file_extensions" ] } } @@ -684187,8 +684285,8 @@ { "allOf": [ { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", "type": "object", "required": [ "type" @@ -684197,21 +684295,22 @@ "type": { "type": "string", "enum": [ - "copilot_code_review" + "max_file_size" ] }, "parameters": { "type": "object", "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 } - } + }, + "required": [ + "max_file_size" + ] } } }, @@ -685402,128 +685501,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -685676,6 +685653,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -686554,6 +686653,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -686675,159 +686927,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -687919,128 +688018,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -688193,6 +688170,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -690046,6 +690145,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -690167,159 +690419,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -691213,128 +691312,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -691487,6 +691464,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -692574,6 +692673,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -692695,159 +692947,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -746010,7 +746109,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -747507,7 +747606,8 @@ "or_boolean_not_supported", "no_accessible_repos", "server_error", - "only_non_semantic_fields_requested" + "only_non_semantic_fields_requested", + "service_unavailable" ] } } @@ -747532,6 +747632,16 @@ "node_id": "MDU6SXNzdWUzNTgwMg==", "number": 132, "title": "Line Number Indexes Beyond 20 Not Displayed", + "type": { + "id": 1, + "node_id": "IT_kwDNJr9H", + "name": "Bug", + "description": "An unexpected problem or behavior", + "color": "red", + "created_at": "2023-10-09T13:30:49Z", + "updated_at": "2024-05-30T18:20:53Z", + "is_enabled": true + }, "user": { "login": "Nick3C", "id": 90254, @@ -791531,7 +791641,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -822963,7 +823073,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -842624,7 +842734,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -846788,7 +846898,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -855262,7 +855372,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -859426,7 +859536,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -867910,7 +868020,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -872074,7 +872184,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -891878,7 +891988,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -907833,7 +907943,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -911997,7 +912107,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -920467,7 +920577,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -924631,7 +924741,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1182938,7 +1183048,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1187441,7 +1187551,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1191968,7 +1192078,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1196479,7 +1196589,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1200992,7 +1201102,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1204488,7 +1204598,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1208163,7 +1208273,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1214680,7 +1214790,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1218355,7 +1218465,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1224872,7 +1224982,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1229496,7 +1229606,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1235064,7 +1235174,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1239688,7 +1239798,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1246583,7 +1246693,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1250957,7 +1251067,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1255539,7 +1255649,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1259925,7 +1260035,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1264488,7 +1264598,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1268905,7 +1269015,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1273435,7 +1273545,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1277885,7 +1277995,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1282323,7 +1282433,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1286689,7 +1286799,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1291222,7 +1291332,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1293311,7 +1293421,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1298601,7 +1298711,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1303100,7 +1303210,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1307218,7 +1307328,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1310360,7 +1310470,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1314729,7 +1314839,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1314931,7 +1315041,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1319267,7 +1319377,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1323636,7 +1323746,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1328072,7 +1328182,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1332411,7 +1332521,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1336779,7 +1336889,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1336981,7 +1337091,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1677593,128 +1677703,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1677867,6 +1677855,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1680900,6 +1681010,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1681021,159 +1681284,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1684207,128 +1684317,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1684481,6 +1684469,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1685281,6 +1685391,159 @@ } } }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "copilot_code_review", + "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "copilot_code_review" + ] + }, + "parameters": { + "type": "object", + "properties": { + "review_draft_pull_requests": { + "type": "boolean", + "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." + }, + "review_on_push": { + "type": "boolean", + "description": "Copilot automatically reviews each new push to the pull request." + } + } + } + } + }, { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", @@ -1685402,159 +1685665,6 @@ ] } } - }, - { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "workflows" - ] - }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { - "type": "string", - "description": "The path to the workflow file" - }, - "ref": { - "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" - }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" - }, - "sha": { - "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - } - } - }, - "required": [ - "workflows" - ] - } - } - }, - { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "code_scanning" - ] - }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" - ] - }, - "security_alerts_threshold": { - "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" - ] - }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - } - } - }, - "required": [ - "code_scanning_tools" - ] - } - } - }, - { - "title": "copilot_code_review", - "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "copilot_code_review" - ] - }, - "parameters": { - "type": "object", - "properties": { - "review_draft_pull_requests": { - "type": "boolean", - "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." - }, - "review_on_push": { - "type": "boolean", - "description": "Copilot automatically reviews each new push to the pull request." - } - } - } - } } ] } @@ -1686183,128 +1686293,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1686457,6 +1686445,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] } @@ -1687088,128 +1687198,6 @@ } } }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths.", - "minimum": 1, - "maximum": 32767 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] - }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] - } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] - }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] - } - } - }, { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", @@ -1687362,6 +1687350,128 @@ } } } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths.", + "minimum": 1, + "maximum": 32767 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } } ] }, @@ -1760539,7 +1760649,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1765163,7 +1765273,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1770732,7 +1770842,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1775356,7 +1775466,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", "null" @@ -1780925,7 +1781035,7 @@ }, "type": { "title": "Issue Type", - "description": "The type of issue.", + "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": [ "object", {"code":"deadline_exceeded","msg":"operation timed out"}