diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 364fbc1d7..6ac90fba6 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "13.0.0", + "version": "13.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -12917,7 +12917,7 @@ "tags": [ "copilot" ], - "operationId": "copilot/get-copilot-seat-assignment-details-for-user", + "operationId": "copilot/get-copilot-seat-details-for-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user" @@ -13284,7 +13284,7 @@ }, "exclude": { "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "items": { "type": "string", "enum": [ @@ -15113,6 +15113,510 @@ "x-octokit": {} } }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-all-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/properties#get-all-custom-properties-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update custom properties for an organization", + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/properties#create-or-update-custom-properties-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "$ref": "#/components/schemas/org-custom-property" + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an organization", + "description": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/properties#get-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update a custom property for an organization", + "description": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/properties#create-or-update-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": "string", + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/properties#remove-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/properties/values": { + "get": { + "summary": "List custom property values for organization repositories", + "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/properties#list-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-repo-custom-property-values" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-custom-property-values" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update custom property values for organization repositories", + "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/properties#create-or-update-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_names": { + "type": "array", + "description": "The names of repositories that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "repository_names", + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-update-custom-property-values" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-repo-custom-property-values" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, "/orgs/{org}/public_members": { "get": { "summary": "List public organization members", @@ -15794,6 +16298,125 @@ "x-octokit": {} } }, + "/orgs/{org}/rulesets/rule-suites": { + "get": { + "summary": "List organization rule suites", + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rule-suites", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-name-in-query" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/actor-name-in-query" + }, + { + "$ref": "#/components/parameters/rule-suite-result" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suites" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + "get": { + "summary": "Get an organization rule suite", + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rule-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/rule-suite-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, "/orgs/{org}/rulesets/{ruleset_id}": { "get": { "summary": "Get an organization repository ruleset", @@ -21306,7 +21929,7 @@ "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { "post": { "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -21597,7 +22220,7 @@ "/repos/{owner}/{repo}/actions/organization-variables": { "get": { "summary": "List repository organization variables", - "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -22070,7 +22693,7 @@ "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22150,7 +22773,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22199,7 +22822,7 @@ "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { "post": { "summary": "Create configuration for a just-in-time runner for a repository", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22293,7 +22916,7 @@ "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "tags": [ "actions" ], @@ -22339,7 +22962,7 @@ "/repos/{owner}/{repo}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "tags": [ "actions" ], @@ -22385,7 +23008,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22432,7 +23055,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22469,7 +23092,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { "get": { "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22507,7 +23130,7 @@ }, "post": { "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22582,7 +23205,7 @@ }, "put": { "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22657,7 +23280,7 @@ }, "delete": { "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -22697,7 +23320,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { "delete": { "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23295,7 +23918,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { "post": { "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -23408,6 +24031,58 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + "post": { + "summary": "Force cancel a workflow run", + "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/force-cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { "get": { "summary": "List jobs for a workflow run", @@ -24216,7 +24891,7 @@ "/repos/{owner}/{repo}/actions/variables": { "get": { "summary": "List repository variables", - "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -24286,7 +24961,7 @@ }, "post": { "summary": "Create a repository variable", - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -24364,7 +25039,7 @@ "/repos/{owner}/{repo}/actions/variables/{name}": { "get": { "summary": "Get a repository variable", - "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -24411,7 +25086,7 @@ }, "patch": { "summary": "Update a repository variable", - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -24474,7 +25149,7 @@ }, "delete": { "summary": "Delete a repository variable", - "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -24927,7 +25602,7 @@ "/repos/{owner}/{repo}/activity": { "get": { "summary": "List repository activities", - "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity).\"", + "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository).\"", "tags": [ "repos" ], @@ -28687,7 +29362,7 @@ }, "patch": { "summary": "Update a check run", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -29360,7 +30035,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -30346,7 +31021,7 @@ } }, "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" + "$ref": "#/components/responses/code_scanning_forbidden_write" }, "404": { "$ref": "#/components/responses/not_found" @@ -31121,6 +31796,87 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/codespaces/permissions_check": { + "get": { + "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user", + "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/check-permissions-for-devcontainer", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "description": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "example": "master" + } + }, + { + "name": "devcontainer_path", + "description": "Path to the devcontainer.json configuration to use for the permission check.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "example": ".devcontainer/example/devcontainer.json" + } + } + ], + "responses": { + "200": { + "description": "Response when the permission check is successful", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "codespaces" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/codespaces/secrets": { "get": { "summary": "List repository secrets", @@ -32638,7 +33394,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "tags": [ "checks" ], @@ -32741,7 +33497,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "tags": [ "checks" ], @@ -32953,7 +33709,7 @@ "/repos/{owner}/{repo}/community/profile": { "get": { "summary": "Get community profile metrics", - "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.", + "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", "tags": [ "repos" ], @@ -35178,6 +35934,9 @@ "wait_timer": { "$ref": "#/components/schemas/wait-timer" }, + "prevent_self_review": { + "$ref": "#/components/schemas/prevent-self-review" + }, "reviewers": { "type": "array", "nullable": true, @@ -35206,6 +35965,7 @@ "default": { "value": { "wait_timer": 30, + "prevent_self_review": false, "reviewers": [ { "type": "User", @@ -35370,7 +36130,7 @@ }, "post": { "summary": "Create a deployment branch policy", - "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -35395,7 +36155,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" }, "examples": { "example-wildcard": { @@ -35407,7 +36167,15 @@ "example-single-branch": { "summary": "Example of a single branch name pattern", "value": { - "name": "main" + "name": "main", + "type": "branch" + } + }, + "example-single-tag": { + "summary": "Example of a single tag name pattern", + "value": { + "name": "v1", + "type": "tag" } } } @@ -35428,6 +36196,9 @@ }, "example-single-branch": { "$ref": "#/components/examples/deployment-branch-policy-single-branch" + }, + "example-single-tag": { + "$ref": "#/components/examples/deployment-branch-policy-single-tag" } } } @@ -35452,7 +36223,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { "get": { "summary": "Get a deployment branch policy", - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "repos" ], @@ -35502,7 +36273,7 @@ }, "put": { "summary": "Update a deployment branch policy", - "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -35569,7 +36340,7 @@ }, "delete": { "summary": "Delete a deployment branch policy", - "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -38060,7 +38831,7 @@ "/repos/{owner}/{repo}/import": { "get": { "summary": "Get an import status", - "description": "View the progress of an import.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "description": "View the progress of an import.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", "tags": [ "migrations" ], @@ -38104,13 +38875,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} }, "put": { "summary": "Start an import", - "description": "Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "description": "Start a source import to a GitHub repository using GitHub Importer.\nImporting into a GitHub repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -38216,13 +38990,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update an import", - "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], @@ -38326,13 +39103,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Cancel an import", - "description": "Stop an import for a repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "Stop an import for a repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -38361,15 +39141,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/authors": { "get": { "summary": "Get commit authors", - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], @@ -38419,15 +39202,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/authors/{author_id}": { "patch": { "summary": "Map a commit author", - "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -38511,15 +39297,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/large_files": { "get": { "summary": "Get large files", - "description": "List files larger than 100MB found during the import\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "List files larger than 100MB found during the import\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -38563,15 +39352,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/lfs": { "patch": { "summary": "Update Git LFS preference", - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/repositories/working-with-files/managing-large-files).\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -38645,8 +39437,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, @@ -43901,6 +44696,61 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/properties/values": { + "get": { + "summary": "Get all custom property values for a repository", + "description": "Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/properties#get-all-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/pulls": { "get": { "summary": "List pull requests", @@ -44405,7 +45255,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -48101,6 +48951,131 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/rulesets/rule-suites": { + "get": { + "summary": "List repository rule suites", + "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rule-suites", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/ref-in-query" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/actor-name-in-query" + }, + { + "$ref": "#/components/parameters/rule-suite-result" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suites" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + "get": { + "summary": "Get a repository rule suite", + "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rule-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/rule-suite-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { "get": { "summary": "Get a repository ruleset", @@ -51343,7 +52318,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables": { "get": { "summary": "List environment variables", - "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -51413,7 +52388,7 @@ }, "post": { "summary": "Create an environment variable", - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -51491,7 +52466,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { "get": { "summary": "Get an environment variable", - "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -51538,7 +52513,7 @@ }, "patch": { "summary": "Update an environment variable", - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -51601,7 +52576,7 @@ }, "delete": { "summary": "Delete an environment variable", - "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -81328,7 +82303,7 @@ }, "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was created.", "operationId": "repository-ruleset/created", "externalDocs": { @@ -81421,7 +82396,7 @@ }, "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was deleted.", "operationId": "repository-ruleset/deleted", "externalDocs": { @@ -81514,7 +82489,7 @@ }, "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was edited.", "operationId": "repository-ruleset/edited", "externalDocs": { @@ -93831,6 +94806,15 @@ "unknown" ] }, + "copilot_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, "seat_management_setting": { "type": "string", "description": "The mode of assigning new seats.", @@ -94193,7 +95177,7 @@ "type": "object", "description": "The assignee that has been granted access to GitHub Copilot.", "additionalProperties": true, - "enum": [ + "oneOf": [ { "$ref": "#/components/schemas/simple-user" }, @@ -95562,6 +96546,104 @@ "updated_at" ] }, + "org-custom-property": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": "string", + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": "string", + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, + "org-repo-custom-property-values": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "example": 1296269 + }, + "repository_name": { + "type": "string", + "example": "Hello-World" + }, + "repository_full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + }, "repository-rule-enforcement": { "type": "string", "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise).", @@ -95583,7 +96665,7 @@ "properties": { "actor_id": { "type": "integer", - "description": "The ID of the actor that can bypass a ruleset" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`." }, "actor_type": { "type": "string", @@ -95781,7 +96863,7 @@ }, "repository-rule-required-linear-history": { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -95797,7 +96879,7 @@ }, "repository-rule-required-deployments": { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -95828,7 +96910,7 @@ }, "repository-rule-required-signatures": { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -95912,7 +96994,7 @@ }, "repository-rule-required-status-checks": { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -95948,7 +97030,7 @@ }, "repository-rule-non-fast-forward": { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -96197,6 +97279,64 @@ } } }, + "repository-rule-params-workflow-file-reference": { + "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" + ] + }, + "repository-rule-workflows": { + "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": { + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } + } + }, + "required": [ + "workflows" + ] + } + } + }, "repository-rule": { "title": "Repository Rule", "type": "object", @@ -96243,6 +97383,9 @@ }, { "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" } ] }, @@ -96356,6 +97499,184 @@ } } }, + "rule-suites": { + "title": "Rule Suites", + "description": "Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." + }, + "actor_id": { + "type": "integer", + "description": "The number that identifies the user." + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account." + }, + "before_sha": { + "type": "string", + "description": "The first commit sha before the push evaluation." + }, + "after_sha": { + "type": "string", + "description": "The last commit sha in the push evaluation." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": "string", + "enum": [ + "pass", + "fail" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." + } + } + } + }, + "rule-suite": { + "title": "Rule Suite", + "description": "Response", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." + }, + "actor_id": { + "type": "integer", + "description": "The number that identifies the user." + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account." + }, + "before_sha": { + "type": "string", + "description": "The first commit sha before the push evaluation." + }, + "after_sha": { + "type": "string", + "description": "The last commit sha in the push evaluation." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": "string", + "enum": [ + "pass", + "fail" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." + }, + "rule_evaluations": { + "type": "array", + "description": "Details on the evaluated rules.", + "items": { + "type": "object", + "properties": { + "rule_source": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of rule source." + }, + "id": { + "type": "integer", + "nullable": true, + "description": "The ID of the rule source." + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of the rule source." + } + } + }, + "enforcement": { + "type": "string", + "enum": [ + "active", + "evaluate", + "deleted ruleset" + ], + "description": "The enforcement level of this rule source." + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail" + ], + "description": "The result of the evaluation of the individual rule." + }, + "rule_type": { + "type": "string", + "description": "The type of rule." + }, + "details": { + "type": "string", + "description": "Any associated details with the rule evaluation." + } + } + } + } + } + }, "repository-advisory-vulnerability": { "description": "A product affected by the vulnerability detailed in a repository security advisory.", "type": "object", @@ -99913,7 +101234,6 @@ "forks", "forks_count", "git_url", - "has_downloads", "has_issues", "has_projects", "has_wiki", @@ -103582,6 +104902,11 @@ "type": "string", "format": "uri", "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property." + }, + "commit_oid": { + "type": "string", + "description": "The commit SHA of the repository at the time the CodeQL database was created.", + "nullable": true } }, "required": [ @@ -103609,7 +104934,7 @@ ] }, "languages": { - "description": "Languages to be analysed.", + "description": "Languages to be analyzed.", "type": "array", "items": { "type": "string", @@ -103673,7 +104998,7 @@ ] }, "languages": { - "description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`.", + "description": "CodeQL languages to be analyzed.", "type": "array", "items": { "type": "string", @@ -103874,6 +105199,21 @@ "prebuild_availability" ] }, + "codespaces-permissions-check-for-devcontainer": { + "title": "Codespaces Permissions Check", + "description": "Permission check result for a given devcontainer config.", + "type": "object", + "properties": { + "accepted": { + "description": "Whether the user has accepted the permissions defined by the devcontainer config", + "example": true, + "type": "boolean" + } + }, + "required": [ + "accepted" + ] + }, "repo-codespaces-secret": { "title": "Codespaces Secret", "description": "Set repository secrets for GitHub Codespaces.", @@ -106676,6 +108016,11 @@ "type": "string", "example": "MDQ6R2F0ZTM3NTU=" }, + "prevent_self_review": { + "type": "boolean", + "example": false, + "description": "Whether deployments to this environment can be approved by the user who created the deployment." + }, "type": { "type": "string", "example": "required_reviewers" @@ -106748,13 +108093,18 @@ "updated_at" ] }, + "prevent-self-review": { + "type": "boolean", + "example": false, + "description": "Whether or not a user who created the job is prevented from approving their own job." + }, "deployment-branch-policy": { "title": "Deployment branch policy", - "description": "Details of a deployment branch policy.", + "description": "Details of a deployment branch or tag policy.", "type": "object", "properties": { "id": { - "description": "The unique identifier of the branch policy.", + "description": "The unique identifier of the branch or tag policy.", "type": "integer", "example": 361471 }, @@ -106763,12 +108113,44 @@ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" }, "name": { - "description": "The name pattern that branches must match in order to deploy to the environment.", + "description": "The name pattern that branches or tags must match in order to deploy to the environment.", "type": "string", "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag.", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] } } }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] + } + }, + "required": [ + "name" + ] + }, "deployment-branch-policy-name-pattern": { "title": "Deployment branch policy name pattern", "type": "object", @@ -113000,6 +114382,16 @@ "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } ] }, @@ -120816,7 +122208,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", "type": "string", "nullable": true, "enum": [ @@ -121597,7 +122989,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -122371,7 +123763,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -122776,7 +124168,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -123095,7 +124487,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -123702,7 +125094,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -130195,7 +131587,7 @@ "format": "date-time" }, "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -154994,6 +156386,10 @@ "type": "string", "format": "uri" }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, "has_downloads": { "description": "Whether downloads are enabled.", "type": "boolean", @@ -155350,6 +156746,10 @@ }, "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" } }, "required": [ @@ -283873,6 +285273,88 @@ "updated_at": "2014-03-04T18:58:10Z" } }, + "org-custom-properties": { + "value": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "org-custom-property": { + "value": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + }, + "org-repo-custom-property-values": { + "value": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ] + }, + "org-repo-update-custom-property-values": { + "value": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "repository": { "value": { "id": 1296269, @@ -284097,6 +285579,81 @@ "updated_at": "2023-09-23T16:29:47Z" } }, + "rule-suite-items": { + "value": [ + { + "id": 21, + "actor_id": 12, + "username": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass" + }, + { + "id": 25, + "actor_id": 11, + "username": "not-octocat", + "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", + "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", + "ref": "refs/heads/i-am-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-07T08:43:03Z", + "result": "pass", + "evaluation_result": "fail" + } + ] + }, + "rule-suite": { + "value": { + "id": 21, + "actor_id": 12, + "username": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass", + "evaluation_result": "fail", + "rule_evaluations": [ + { + "rule_source": { + "type": "ruleset", + "id": 2, + "name": "Author email must be a GitHub email address" + }, + "enforcement": "active", + "result": "pass", + "rule_type": "commit_author_email_pattern" + }, + { + "rule_source": { + "type": "protected_branch" + }, + "enforcement": "active", + "result": "fail", + "rule_type": "pull_request", + "details": "Changes must be made through a pull request." + }, + { + "rule_source": { + "type": "ruleset", + "id": 3, + "name": "Evaluate commit message pattern" + }, + "enforcement": "evaluate", + "result": "fail", + "rule_type": "commit_message_pattern" + } + ] + } + }, "list-repository-advisories": { "value": [ { @@ -286636,7 +288193,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -287310,7 +288867,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -289846,7 +291403,8 @@ "size": 1024, "created_at": "2022-09-12T12:14:32Z", "updated_at": "2022-09-12T12:14:32Z", - "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java" + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" }, { "id": 2, @@ -289876,7 +291434,8 @@ "size": 1024, "created_at": "2022-09-12T12:14:32Z", "updated_at": "2022-09-12T12:14:32Z", - "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby" + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" } ] }, @@ -289909,7 +291468,8 @@ "size": 1024, "created_at": "2022-09-12T12:14:32Z", "updated_at": "2022-09-12T12:14:32Z", - "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java" + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" } }, "code-scanning-default-setup": { @@ -290338,6 +291898,11 @@ } } }, + "codespaces-permissions-check-for-devcontainer": { + "value": { + "accepted": true + } + }, "collaborator-items": { "value": [ { @@ -293091,6 +294656,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -293169,6 +294735,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -293257,6 +294824,14 @@ "name": "main" } }, + "deployment-branch-policy-single-tag": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "v1", + "type": "tag" + } + }, "deployment-protection-rules": { "value": [ { @@ -295569,6 +297144,22 @@ } ] }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -305694,7 +307285,7 @@ }, "hook-id": { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "path", "required": true, "schema": { @@ -305862,6 +307453,71 @@ "type": "integer" } }, + "custom-property-name": { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "repository-name-in-query": { + "name": "repository_name", + "description": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.", + "in": "query", + "schema": { + "type": "integer" + } + }, + "time-period": { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + "actor-name-in-query": { + "name": "actor_name", + "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.", + "in": "query", + "schema": { + "type": "string" + } + }, + "rule-suite-result": { + "name": "rule_suite_result", + "description": "The rule results to filter on. When specified, only suites with this result will be returned.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass", + "all" + ], + "default": "all" + } + }, + "rule-suite-id": { + "name": "rule_suite_id", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "secret-scanning-pagination-before-org-repo": { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", @@ -306407,6 +308063,15 @@ "type": "integer" } }, + "ref-in-query": { + "name": "ref", + "description": "The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "query", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "tag-protection-id": { "name": "tag_protection_id", "description": "The unique identifier of the tag protection.", diff --git a/cache/ghec.json b/cache/ghec.json index 68f61c93a..cb99e9866 100644 --- a/cache/ghec.json +++ b/cache/ghec.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "13.0.0", + "version": "13.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -17543,7 +17543,7 @@ "tags": [ "copilot" ], - "operationId": "copilot/get-copilot-seat-assignment-details-for-user", + "operationId": "copilot/get-copilot-seat-details-for-user", "externalDocs": { "description": "API method documentation", "url": "https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-for-business#get-copilot-for-business-seat-assignment-details-for-a-user" @@ -17910,7 +17910,7 @@ }, "exclude": { "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "items": { "type": "string", "enum": [ @@ -19739,6 +19739,510 @@ "x-octokit": {} } }, + "/orgs/{org}/properties/schema": { + "get": { + "summary": "Get all custom properties for an organization", + "description": "Gets all custom properties defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-all-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/properties#get-all-custom-properties-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update custom properties for an organization", + "description": "Creates new or updates existing custom properties defined for an organization in a batch.\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/properties#create-or-update-custom-properties-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "properties": { + "type": "array", + "description": "The array of custom properties to create or update.", + "items": { + "$ref": "#/components/schemas/org-custom-property" + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-custom-property" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-properties" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an organization", + "description": "Gets a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/properties#get-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "put": { + "summary": "Create or update a custom property for an organization", + "description": "Creates a new or updates an existing custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/properties#create-or-update-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": "string", + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/org-custom-property" + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-custom-property" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Remove a custom property for an organization", + "description": "Removes a custom property that is defined for an organization.\nYou must be an organization owner to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/properties#remove-a-custom-property-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/custom-property-name" + } + ], + "responses": { + "204": { + "$ref": "#/components/responses/no_content" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/properties/values": { + "get": { + "summary": "List custom property values for organization repositories", + "description": "Lists organization repositories with all of their custom property values.\nOrganization members can read these properties.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/properties#list-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-repo-custom-property-values" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-custom-property-values" + } + } + } + }, + "headers": { + "Link": { + "$ref": "#/components/headers/link" + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + }, + "patch": { + "summary": "Create or update custom property values for organization repositories", + "description": "Create new or update existing custom property values for repositories in a batch that belong to an organization.\nEach target repository will have its custom property values updated to match the values provided in the request.\n\nA maximum of 30 repositories can be updated in a single request.\n\nUsing a value of `null` for a custom property will remove or 'unset' the property value from the repository.\n\nOnly organization owners (or users with the proper permissions granted by them) can update these properties", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-or-update-custom-properties-values-for-repos", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/properties#create-or-update-custom-property-values-for-organization-repositories" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "repository_names": { + "type": "array", + "description": "The names of repositories that the custom property values will be applied to.", + "items": { + "type": "string" + }, + "minItems": 1, + "maxItems": 30 + }, + "properties": { + "type": "array", + "description": "List of custom property names and associated values to apply to the repositories.", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + } + }, + "required": [ + "repository_names", + "properties" + ] + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-update-custom-property-values" + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/org-repo-custom-property-values" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/org-repo-custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, "/orgs/{org}/public_members": { "get": { "summary": "List public organization members", @@ -20466,6 +20970,125 @@ "x-octokit": {} } }, + "/orgs/{org}/rulesets/rule-suites": { + "get": { + "summary": "List organization rule suites", + "description": "Lists suites of rule evaluations at the organization level.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rule-suites", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/repository-name-in-query" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/actor-name-in-query" + }, + { + "$ref": "#/components/parameters/rule-suite-result" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suites" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + "get": { + "summary": "Get an organization rule suite", + "description": "Gets information about a suite of rule evaluations from within an organization.\nFor more information, see \"[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-org-rule-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/rule-suite-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, "/orgs/{org}/rulesets/{ruleset_id}": { "get": { "summary": "Get an organization repository ruleset", @@ -26392,7 +27015,7 @@ "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { "post": { "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -26683,7 +27306,7 @@ "/repos/{owner}/{repo}/actions/organization-variables": { "get": { "summary": "List repository organization variables", - "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -27156,7 +27779,7 @@ "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27236,7 +27859,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27285,7 +27908,7 @@ "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { "post": { "summary": "Create configuration for a just-in-time runner for a repository", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27379,7 +28002,7 @@ "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "tags": [ "actions" ], @@ -27425,7 +28048,7 @@ "/repos/{owner}/{repo}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "tags": [ "actions" ], @@ -27471,7 +28094,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27518,7 +28141,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27555,7 +28178,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { "get": { "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27593,7 +28216,7 @@ }, "post": { "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27668,7 +28291,7 @@ }, "put": { "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27743,7 +28366,7 @@ }, "delete": { "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27783,7 +28406,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { "delete": { "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -28381,7 +29004,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { "post": { "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -28494,6 +29117,58 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + "post": { + "summary": "Force cancel a workflow run", + "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/force-cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { "get": { "summary": "List jobs for a workflow run", @@ -29302,7 +29977,7 @@ "/repos/{owner}/{repo}/actions/variables": { "get": { "summary": "List repository variables", - "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -29372,7 +30047,7 @@ }, "post": { "summary": "Create a repository variable", - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -29450,7 +30125,7 @@ "/repos/{owner}/{repo}/actions/variables/{name}": { "get": { "summary": "Get a repository variable", - "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -29497,7 +30172,7 @@ }, "patch": { "summary": "Update a repository variable", - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -29560,7 +30235,7 @@ }, "delete": { "summary": "Delete a repository variable", - "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -30013,7 +30688,7 @@ "/repos/{owner}/{repo}/activity": { "get": { "summary": "List repository activities", - "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing repository activity](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity).\"", + "description": "Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users.\n\nFor more information about viewing repository activity,\nsee \"[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository).\"", "tags": [ "repos" ], @@ -33773,7 +34448,7 @@ }, "patch": { "summary": "Update a check run", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -34446,7 +35121,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -35440,7 +36115,7 @@ } }, "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" + "$ref": "#/components/responses/code_scanning_forbidden_write" }, "404": { "$ref": "#/components/responses/not_found" @@ -36215,6 +36890,87 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/codespaces/permissions_check": { + "get": { + "summary": "Check if permissions defined by a devcontainer have been accepted by the authenticated user", + "description": "Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user.\n\nYou must authenticate using an access token with the `codespace` scope to use this endpoint.\n\nGitHub Apps must have write access to the `codespaces` repository permission to use this endpoint.", + "tags": [ + "codespaces" + ], + "operationId": "codespaces/check-permissions-for-devcontainer", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#check-if-permissions-defined-by-a-devcontainer-have-been-accepted-by-the-authenticated-user" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "name": "ref", + "description": "The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "example": "master" + } + }, + { + "name": "devcontainer_path", + "description": "Path to the devcontainer.json configuration to use for the permission check.", + "in": "query", + "required": true, + "schema": { + "type": "string", + "example": ".devcontainer/example/devcontainer.json" + } + } + ], + "responses": { + "200": { + "description": "Response when the permission check is successful", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/codespaces-permissions-check-for-devcontainer" + }, + "examples": { + "default": { + "$ref": "#/components/examples/codespaces-permissions-check-for-devcontainer" + } + } + } + } + }, + "401": { + "$ref": "#/components/responses/requires_authentication" + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + }, + "503": { + "$ref": "#/components/responses/service_unavailable" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "codespaces", + "subcategory": "codespaces" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/codespaces/secrets": { "get": { "summary": "List repository secrets", @@ -37732,7 +38488,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "tags": [ "checks" ], @@ -37835,7 +38591,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "tags": [ "checks" ], @@ -38047,7 +38803,7 @@ "/repos/{owner}/{repo}/community/profile": { "get": { "summary": "Get community profile metrics", - "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthese four documents are present: README, CONTRIBUTING, LICENSE, and\nCODE_OF_CONDUCT. For example, if all four documents are present, then\nthe `health_percentage` is `100`. If only one is present, then the\n`health_percentage` is `25`.\n\n`content_reports_enabled` is only returned for organization-owned repositories.", + "description": "Returns all community profile metrics for a repository. The repository cannot be a fork.\n\nThe returned metrics include an overall health score, the repository description, the presence of documentation, the\ndetected code of conduct, the detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE,\nREADME, and CONTRIBUTING files.\n\nThe `health_percentage` score is defined as a percentage of how many of\nthe recommended community health files are present. For more information, see\n\"[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories).\"\n\n`content_reports_enabled` is only returned for organization-owned repositories.", "tags": [ "repos" ], @@ -40272,6 +41028,9 @@ "wait_timer": { "$ref": "#/components/schemas/wait-timer" }, + "prevent_self_review": { + "$ref": "#/components/schemas/prevent-self-review" + }, "reviewers": { "type": "array", "nullable": true, @@ -40300,6 +41059,7 @@ "default": { "value": { "wait_timer": 30, + "prevent_self_review": false, "reviewers": [ { "type": "User", @@ -40464,7 +41224,7 @@ }, "post": { "summary": "Create a deployment branch policy", - "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -40489,7 +41249,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" }, "examples": { "example-wildcard": { @@ -40501,7 +41261,15 @@ "example-single-branch": { "summary": "Example of a single branch name pattern", "value": { - "name": "main" + "name": "main", + "type": "branch" + } + }, + "example-single-tag": { + "summary": "Example of a single tag name pattern", + "value": { + "name": "v1", + "type": "tag" } } } @@ -40522,6 +41290,9 @@ }, "example-single-branch": { "$ref": "#/components/examples/deployment-branch-policy-single-branch" + }, + "example-single-tag": { + "$ref": "#/components/examples/deployment-branch-policy-single-tag" } } } @@ -40546,7 +41317,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { "get": { "summary": "Get a deployment branch policy", - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "repos" ], @@ -40596,7 +41367,7 @@ }, "put": { "summary": "Update a deployment branch policy", - "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -40663,7 +41434,7 @@ }, "delete": { "summary": "Delete a deployment branch policy", - "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -43154,7 +43925,7 @@ "/repos/{owner}/{repo}/import": { "get": { "summary": "Get an import status", - "description": "View the progress of an import.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "description": "View the progress of an import.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", "tags": [ "migrations" ], @@ -43198,13 +43969,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} }, "put": { "summary": "Start an import", - "description": "Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "description": "Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer.\nImporting into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will\nreturn a status `422 Unprocessable Entity` response.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -43310,13 +44084,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} }, "patch": { "summary": "Update an import", - "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], @@ -43420,13 +44197,16 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} }, "delete": { "summary": "Cancel an import", - "description": "Stop an import for a repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "Stop an import for a repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -43455,15 +44235,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/authors": { "get": { "summary": "Get commit authors", - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).", "tags": [ "migrations" ], @@ -43513,15 +44296,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/authors/{author_id}": { "patch": { "summary": "Map a commit author", - "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -43605,15 +44391,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/large_files": { "get": { "summary": "Get large files", - "description": "List files larger than 100MB found during the import\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "List files larger than 100MB found during the import\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -43657,15 +44446,18 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, "/repos/{owner}/{repo}/import/lfs": { "patch": { "summary": "Update Git LFS preference", - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files).\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files).\n\n**Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation).\n", "tags": [ "migrations" ], @@ -43739,8 +44531,11 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "category": "migrations", - "subcategory": "source-imports" + "subcategory": "source-imports", + "deprecationDate": "2023-10-12", + "removalDate": "2024-04-12" }, + "deprecated": true, "x-octokit": {} } }, @@ -49068,6 +49863,61 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/properties/values": { + "get": { + "summary": "Get all custom property values for a repository", + "description": "Gets all custom property values that are set for a repository.\nUsers with admin access to the repository can use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-custom-properties-values", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/properties#get-all-custom-property-values-for-a-repository" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/custom-property-values" + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "properties" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/pulls": { "get": { "summary": "List pull requests", @@ -49572,7 +50422,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -53268,6 +54118,131 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/rulesets/rule-suites": { + "get": { + "summary": "List repository rule suites", + "description": "Lists suites of rule evaluations at the repository level.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rule-suites", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/ref-in-query" + }, + { + "$ref": "#/components/parameters/time-period" + }, + { + "$ref": "#/components/parameters/actor-name-in-query" + }, + { + "$ref": "#/components/parameters/rule-suite-result" + }, + { + "$ref": "#/components/parameters/per-page" + }, + { + "$ref": "#/components/parameters/page" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suites" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite-items" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, + "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + "get": { + "summary": "Get a repository rule suite", + "description": "Gets information about a suite of rule evaluations from within a repository.\nFor more information, see \"[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets).\"", + "tags": [ + "repos" + ], + "operationId": "repos/get-repo-rule-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/rule-suite-id" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/rule-suite" + }, + "examples": { + "default": { + "$ref": "#/components/examples/rule-suite" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "rule-suites" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { "get": { "summary": "Get a repository ruleset", @@ -56510,7 +57485,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables": { "get": { "summary": "List environment variables", - "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -56580,7 +57555,7 @@ }, "post": { "summary": "Create an environment variable", - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -56658,7 +57633,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { "get": { "summary": "Get an environment variable", - "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -56705,7 +57680,7 @@ }, "patch": { "summary": "Update an environment variable", - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -56768,7 +57743,7 @@ }, "delete": { "summary": "Delete an environment variable", - "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -86934,11 +87909,104 @@ } } }, - "release-prereleased": { + "release-prereleased": { + "post": { + "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", + "operationId": "release/prereleased", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-release-prereleased" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "release", + "supported-webhook-types": [ + "repository", + "organization", + "app" + ] + } + } + }, + "release-published": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.", - "operationId": "release/prereleased", + "description": "A release, pre-release, or draft of a release was published.", + "operationId": "release/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -87005,7 +88073,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-prereleased" + "$ref": "#/components/schemas/webhook-release-published" } } } @@ -87027,11 +88095,11 @@ } } }, - "release-published": { + "release-released": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release, pre-release, or draft of a release was published.", - "operationId": "release/published", + "description": "A release was published, or a pre-release was changed to a release.", + "operationId": "release/released", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -87098,7 +88166,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-published" + "$ref": "#/components/schemas/webhook-release-released" } } } @@ -87120,11 +88188,11 @@ } } }, - "release-released": { + "release-unpublished": { "post": { "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release was published, or a pre-release was changed to a release.", - "operationId": "release/released", + "description": "A release or pre-release was unpublished.", + "operationId": "release/unpublished", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" }, @@ -87191,7 +88259,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-released" + "$ref": "#/components/schemas/webhook-release-unpublished" } } } @@ -87213,13 +88281,13 @@ } } }, - "release-unpublished": { + "repository-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to releases. For more information, see \"[About releases](https://docs.github.com/enterprise-cloud@latest//repositories/releasing-projects-on-github/about-releases).\" For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest//rest/releases)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "A release or pre-release was unpublished.", - "operationId": "release/unpublished", + "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", + "description": "A repository security advisory was published.", + "operationId": "repository-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#release" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { @@ -87284,7 +88352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-release-unpublished" + "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } @@ -87297,7 +88365,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "release", + "subcategory": "repository_advisory", "supported-webhook-types": [ "repository", "organization", @@ -87306,11 +88374,11 @@ } } }, - "repository-advisory-published": { + "repository-advisory-reported": { "post": { "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A repository security advisory was published.", - "operationId": "repository-advisory/published", + "description": "A private vulnerability report was submitted.", + "operationId": "repository-advisory/reported", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" }, @@ -87377,7 +88445,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-published" + "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } @@ -87399,13 +88467,13 @@ } } }, - "repository-advisory-reported": { + "repository-archived": { "post": { - "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", - "description": "A private vulnerability report was submitted.", - "operationId": "repository-advisory/reported", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A repository was archived.", + "operationId": "repository/archived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -87470,7 +88538,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-advisory-reported" + "$ref": "#/components/schemas/webhook-repository-archived" } } } @@ -87483,8 +88551,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_advisory", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -87492,11 +88561,11 @@ } } }, - "repository-archived": { + "repository-created": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was archived.", - "operationId": "repository/archived", + "description": "A repository was created.", + "operationId": "repository/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -87563,7 +88632,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-archived" + "$ref": "#/components/schemas/webhook-repository-created" } } } @@ -87586,11 +88655,196 @@ } } }, - "repository-created": { + "repository-deleted": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was created.", - "operationId": "repository/created", + "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", + "operationId": "repository/deleted", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-deleted" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository", + "supported-webhook-types": [ + "business", + "repository", + "organization", + "app" + ] + } + } + }, + "repository-dispatch-sample.collected": { + "post": { + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", + "operationId": "repository-dispatch/sample.collected", + "externalDocs": { + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" + }, + "parameters": [ + { + "name": "User-Agent", + "in": "header", + "example": "GitHub-Hookshot/123abc", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Id", + "in": "header", + "example": 12312312, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Event", + "in": "header", + "example": "issues", + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Id", + "in": "header", + "example": 123123, + "schema": { + "type": "string" + } + }, + { + "name": "X-Github-Hook-Installation-Target-Type", + "in": "header", + "example": "repository", + "schema": { + "type": "string" + } + }, + { + "name": "X-GitHub-Delivery", + "in": "header", + "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", + "schema": { + "type": "string" + } + }, + { + "name": "X-Hub-Signature-256", + "in": "header", + "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/webhook-repository-dispatch-sample" + } + } + } + }, + "responses": { + "200": { + "description": "Return a 200 status to indicate that the data was received successfully" + } + }, + "x-github": { + "githubCloudOnly": false, + "category": "webhooks", + "subcategory": "repository_dispatch", + "supported-webhook-types": [ + "app" + ] + } + } + }, + "repository-edited": { + "post": { + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The topics, default branch, description, or homepage of a repository was changed.", + "operationId": "repository/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -87657,7 +88911,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-created" + "$ref": "#/components/schemas/webhook-repository-edited" } } } @@ -87680,13 +88934,12 @@ } } }, - "repository-deleted": { + "repository-import": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A repository was deleted. GitHub Apps and repository webhooks will not receive this event.", - "operationId": "repository/deleted", + "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", + "operationId": "repository-import", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { @@ -87751,7 +89004,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-deleted" + "$ref": "#/components/schemas/webhook-repository-import" } } } @@ -87764,112 +89017,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_import", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" - ] - } - } - }, - "repository-dispatch-sample.collected": { - "post": { - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", - "operationId": "repository-dispatch/sample.collected", - "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_dispatch" - }, - "parameters": [ - { - "name": "User-Agent", - "in": "header", - "example": "GitHub-Hookshot/123abc", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Id", - "in": "header", - "example": 12312312, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Event", - "in": "header", - "example": "issues", - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Id", - "in": "header", - "example": 123123, - "schema": { - "type": "string" - } - }, - { - "name": "X-Github-Hook-Installation-Target-Type", - "in": "header", - "example": "repository", - "schema": { - "type": "string" - } - }, - { - "name": "X-GitHub-Delivery", - "in": "header", - "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", - "schema": { - "type": "string" - } - }, - { - "name": "X-Hub-Signature-256", - "in": "header", - "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/webhook-repository-dispatch-sample" - } - } - } - }, - "responses": { - "200": { - "description": "Return a 200 status to indicate that the data was received successfully" - } - }, - "x-github": { - "githubCloudOnly": false, - "category": "webhooks", - "subcategory": "repository_dispatch", - "supported-webhook-types": [ - "app" + "organization" ] } } }, - "repository-edited": { + "repository-privatized": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The topics, default branch, description, or homepage of a repository was changed.", - "operationId": "repository/edited", + "description": "The visibility of a repository was changed to `private`.", + "operationId": "repository/privatized", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -87936,7 +89096,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-edited" + "$ref": "#/components/schemas/webhook-repository-privatized" } } } @@ -87959,12 +89119,13 @@ } } }, - "repository-import": { + "repository-publicized": { "post": { - "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest//get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports).", - "operationId": "repository-import", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "The visibility of a repository was changed to `public`.", + "operationId": "repository/publicized", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_import" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -88029,7 +89190,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-import" + "$ref": "#/components/schemas/webhook-repository-publicized" } } } @@ -88042,19 +89203,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_import", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", - "organization" + "organization", + "app" ] } } }, - "repository-privatized": { + "repository-renamed": { "post": { "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `private`.", - "operationId": "repository/privatized", + "description": "The name of a repository was changed.", + "operationId": "repository/renamed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, @@ -88121,7 +89284,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-privatized" + "$ref": "#/components/schemas/webhook-repository-renamed" } } } @@ -88144,13 +89307,13 @@ } } }, - "repository-publicized": { + "repository-ruleset-created": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The visibility of a repository was changed to `public`.", - "operationId": "repository/publicized", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was created.", + "operationId": "repository-ruleset/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -88215,7 +89378,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-publicized" + "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } @@ -88228,9 +89391,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -88238,13 +89400,13 @@ } } }, - "repository-renamed": { + "repository-ruleset-deleted": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "The name of a repository was changed.", - "operationId": "repository/renamed", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was deleted.", + "operationId": "repository-ruleset/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { @@ -88309,7 +89471,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-renamed" + "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } @@ -88322,9 +89484,8 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_ruleset", "supported-webhook-types": [ - "business", "repository", "organization", "app" @@ -88332,11 +89493,11 @@ } } }, - "repository-ruleset-created": { + "repository-ruleset-edited": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A repository ruleset was created.", - "operationId": "repository-ruleset/created", + "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", + "description": "A repository ruleset was edited.", + "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" }, @@ -88403,7 +89564,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-created" + "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } @@ -88425,13 +89586,13 @@ } } }, - "repository-ruleset-deleted": { + "repository-transferred": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A repository ruleset was deleted.", - "operationId": "repository-ruleset/deleted", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", + "operationId": "repository/transferred", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -88496,7 +89657,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" + "$ref": "#/components/schemas/webhook-repository-transferred" } } } @@ -88509,8 +89670,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -88518,13 +89680,13 @@ } } }, - "repository-ruleset-edited": { + "repository-unarchived": { "post": { - "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest//rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "description": "A repository ruleset was edited.", - "operationId": "repository-ruleset/edited", + "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "A previously archived repository was unarchived.", + "operationId": "repository/unarchived", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_ruleset" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { @@ -88589,7 +89751,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-ruleset-edited" + "$ref": "#/components/schemas/webhook-repository-unarchived" } } } @@ -88602,8 +89764,9 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_ruleset", + "subcategory": "repository", "supported-webhook-types": [ + "business", "repository", "organization", "app" @@ -88611,13 +89774,13 @@ } } }, - "repository-transferred": { + "repository-vulnerability-alert-create": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to \"Repository\" events.", - "operationId": "repository/transferred", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was created.", + "operationId": "repository-vulnerability-alert/create", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -88682,7 +89845,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-transferred" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" } } } @@ -88695,23 +89858,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-unarchived": { + "repository-vulnerability-alert-dismiss": { "post": { - "summary": "This event occurs when there is activity relating to repositories. For more information, see \"[About repositories](https://docs.github.com/enterprise-cloud@latest//repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest//rest/repos)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "A previously archived repository was unarchived.", - "operationId": "repository/unarchived", + "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.", + "description": "A repository vulnerability alert was dismissed.", + "operationId": "repository-vulnerability-alert/dismiss", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { @@ -88776,7 +89937,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-unarchived" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" } } } @@ -88789,21 +89950,19 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository", + "subcategory": "repository_vulnerability_alert", "supported-webhook-types": [ - "business", "repository", - "organization", - "app" + "organization" ] } } }, - "repository-vulnerability-alert-create": { + "repository-vulnerability-alert-reopen": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was created.", - "operationId": "repository-vulnerability-alert/create", + "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", + "operationId": "repository-vulnerability-alert/reopen", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -88870,7 +90029,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-create" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" } } } @@ -88891,11 +90050,11 @@ } } }, - "repository-vulnerability-alert-dismiss": { + "repository-vulnerability-alert-resolve": { "post": { "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was dismissed.", - "operationId": "repository-vulnerability-alert/dismiss", + "description": "A repository vulnerability alert was marked as resolved.", + "operationId": "repository-vulnerability-alert/resolve", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, @@ -88962,7 +90121,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-dismiss" + "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" } } } @@ -88983,13 +90142,13 @@ } } }, - "repository-vulnerability-alert-reopen": { + "secret-scanning-alert-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.", - "description": "A previously dismissed or resolved repository vulnerability alert was reopened.", - "operationId": "repository-vulnerability-alert/reopen", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was created.", + "operationId": "secret-scanning-alert/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -89054,7 +90213,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-reopen" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" } } } @@ -89067,21 +90226,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "repository-vulnerability-alert-resolve": { + "secret-scanning-alert-location-created": { "post": { - "summary": "This event occurs when there is activity relating to a security vulnerability alert in a repository.\n\n**Note**: This event is deprecated. Use the `dependabot_alert` event instead.", - "description": "A repository vulnerability alert was marked as resolved.", - "operationId": "repository-vulnerability-alert/resolve", + "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", + "operationId": "secret-scanning-alert-location/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#repository_vulnerability_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { @@ -89146,7 +90306,22 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-repository-vulnerability-alert-resolve" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created" + } + } + }, + "application/x-www-form-urlencoded": { + "schema": { + "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" + }, + "examples": { + "default": { + "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" + } } } } @@ -89158,20 +90333,22 @@ }, "x-github": { "githubCloudOnly": false, + "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "repository_vulnerability_alert", + "subcategory": "secret_scanning_alert_location", "supported-webhook-types": [ "repository", - "organization" + "organization", + "app" ] } } }, - "secret-scanning-alert-created": { + "secret-scanning-alert-reopened": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was created.", - "operationId": "secret-scanning-alert/created", + "description": "A previously closed secret scanning alert was reopened.", + "operationId": "secret-scanning-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -89238,7 +90415,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-created" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" } } } @@ -89260,13 +90437,13 @@ } } }, - "secret-scanning-alert-location-created": { + "secret-scanning-alert-resolved": { "post": { - "summary": "This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.", - "operationId": "secret-scanning-alert-location/created", + "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", + "description": "A secret scanning alert was closed.", + "operationId": "secret-scanning-alert/resolved", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert_location" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { @@ -89331,22 +90508,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created" - } - } - }, - "application/x-www-form-urlencoded": { - "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded" - }, - "examples": { - "default": { - "$ref": "#/components/examples/secret-scanning-alert-location-created-form-encoded" - } + "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" } } } @@ -89358,9 +90520,8 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, "category": "webhooks", - "subcategory": "secret_scanning_alert_location", + "subcategory": "secret_scanning_alert", "supported-webhook-types": [ "repository", "organization", @@ -89369,11 +90530,11 @@ } } }, - "secret-scanning-alert-reopened": { + "secret-scanning-alert-revoked": { "post": { "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A previously closed secret scanning alert was reopened.", - "operationId": "secret-scanning-alert/reopened", + "description": "A secret scanning alert was marked as revoked.", + "operationId": "secret-scanning-alert/revoked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" }, @@ -89440,7 +90601,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-reopened" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" } } } @@ -89462,13 +90623,13 @@ } } }, - "secret-scanning-alert-resolved": { + "security-advisory-published": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was closed.", - "operationId": "secret-scanning-alert/resolved", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "A security advisory was published to the GitHub community.", + "operationId": "security-advisory/published", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -89533,7 +90694,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-resolved" + "$ref": "#/components/schemas/webhook-security-advisory-published" } } } @@ -89546,22 +90707,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "secret-scanning-alert-revoked": { + "security-advisory-updated": { "post": { - "summary": "This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/about-secret-scanning).\" For information about the API to manage secret scanning alerts, see \"[Secret scanning](https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", - "description": "A secret scanning alert was marked as revoked.", - "operationId": "secret-scanning-alert/revoked", + "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", + "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", + "operationId": "security-advisory/updated", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#secret_scanning_alert" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { @@ -89626,7 +90785,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-secret-scanning-alert-revoked" + "$ref": "#/components/schemas/webhook-security-advisory-updated" } } } @@ -89639,20 +90798,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "secret_scanning_alert", + "subcategory": "security_advisory", "supported-webhook-types": [ - "repository", - "organization", "app" ] } } }, - "security-advisory-published": { + "security-advisory-withdrawn": { "post": { "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A security advisory was published to the GitHub community.", - "operationId": "security-advisory/published", + "description": "A previously published security advisory was withdrawn.", + "operationId": "security-advisory/withdrawn", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" }, @@ -89719,7 +90876,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" } } } @@ -89739,13 +90896,12 @@ } } }, - "security-advisory-updated": { + "security-and-analysis": { "post": { - "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "The metadata or description of a security advisory was changed, or the security advisory was withdrawn.", - "operationId": "security-advisory/updated", + "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", + "operationId": "security-and-analysis", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { @@ -89810,7 +90966,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-security-and-analysis" } } } @@ -89823,20 +90979,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "security_and_analysis", "supported-webhook-types": [ + "repository", + "organization", "app" ] } } }, - "security-advisory-withdrawn": { + "sponsorship-cancelled": { "post": { - "summary": "This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest//code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\" For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\"", - "description": "A previously published security advisory was withdrawn.", - "operationId": "security-advisory/withdrawn", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/cancelled", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_advisory" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -89901,7 +91059,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" } } } @@ -89914,19 +91072,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_advisory", + "subcategory": "sponsorship", "supported-webhook-types": [ - "app" + "sponsors_listing" ] } } }, - "security-and-analysis": { + "sponsorship-created": { "post": { - "summary": "This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see \"[GitHub security features](https://docs.github.com/enterprise-cloud@latest//code-security/getting-started/github-security-features).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", - "operationId": "security-and-analysis", + "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", + "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", + "operationId": "sponsorship/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#security_and_analysis" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { @@ -89991,7 +91150,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-sponsorship-created" } } } @@ -90004,20 +91163,18 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "security_and_analysis", + "subcategory": "sponsorship", "supported-webhook-types": [ - "repository", - "organization", - "app" + "sponsors_listing" ] } } }, - "sponsorship-cancelled": { + "sponsorship-edited": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsorship was cancelled and the last billing cycle has ended.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/cancelled", + "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", + "operationId": "sponsorship/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -90084,7 +91241,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-sponsorship-edited" } } } @@ -90104,11 +91261,11 @@ } } }, - "sponsorship-created": { + "sponsorship-pending-cancellation": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.", - "operationId": "sponsorship/created", + "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", + "operationId": "sponsorship/pending-cancellation", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -90175,7 +91332,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" } } } @@ -90195,11 +91352,11 @@ } } }, - "sponsorship-edited": { + "sponsorship-pending-tier-change": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.", - "operationId": "sponsorship/edited", + "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", + "operationId": "sponsorship/pending-tier-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -90266,7 +91423,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" } } } @@ -90286,11 +91443,11 @@ } } }, - "sponsorship-pending-cancellation": { + "sponsorship-tier-changed": { "post": { "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.\n\nThis event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.", - "operationId": "sponsorship/pending-cancellation", + "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", + "operationId": "sponsorship/tier-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" }, @@ -90357,7 +91514,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" } } } @@ -90377,13 +91534,13 @@ } } }, - "sponsorship-pending-tier-change": { + "star-created": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.", - "operationId": "sponsorship/pending-tier-change", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone starred a repository.", + "operationId": "star/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -90448,7 +91605,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-star-created" } } } @@ -90461,20 +91618,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "star", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "sponsorship-tier-changed": { + "star-deleted": { "post": { - "summary": "This event occurs when there is activity relating to a sponsorship listing. For more information, see \"[About GitHub Sponsors](https://docs.github.com/enterprise-cloud@latest//sponsors/getting-started-with-github-sponsors/about-github-sponsors).\" For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#sponsorship).\n\nYou can only create a sponsorship webhook on GitHub.com. For more information, see \"[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-cloud@latest//sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account).\"", - "description": "A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.", - "operationId": "sponsorship/tier-changed", + "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", + "description": "Someone unstarred the repository.", + "operationId": "star/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#sponsorship" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" }, "parameters": [ { @@ -90539,7 +91698,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-star-deleted" } } } @@ -90552,20 +91711,21 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "sponsorship", + "subcategory": "star", "supported-webhook-types": [ - "sponsors_listing" + "repository", + "organization", + "app" ] } } }, - "star-created": { + "status": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone starred a repository.", - "operationId": "star/created", + "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", + "operationId": "status", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" }, "parameters": [ { @@ -90630,7 +91790,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-status" } } } @@ -90643,7 +91803,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "status", "supported-webhook-types": [ "repository", "organization", @@ -90652,13 +91812,12 @@ } } }, - "star-deleted": { + "team-add": { "post": { - "summary": "This event occurs when there is activity relating to repository stars. For more information about stars, see \"[Saving repositories with stars](https://docs.github.com/enterprise-cloud@latest//get-started/exploring-projects-on-github/saving-repositories-with-stars).\" For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest//rest/activity/starring)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", - "description": "Someone unstarred the repository.", - "operationId": "star/deleted", + "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "operationId": "team-add", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#star" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { @@ -90723,7 +91882,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-team-add" } } } @@ -90736,7 +91895,7 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "star", + "subcategory": "team_add", "supported-webhook-types": [ "repository", "organization", @@ -90745,12 +91904,13 @@ } } }, - "status": { + "team-added-to-repository": { "post": { - "summary": "This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see \"[About status checks](https://docs.github.com/enterprise-cloud@latest//pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks).\" For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Commit statuses\" repository permission.", - "operationId": "status", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team was granted access to a repository.", + "operationId": "team/added-to-repository", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#status" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -90815,7 +91975,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-team-added-to-repository" } } } @@ -90828,21 +91988,22 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "status", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "team-add": { + "team-created": { "post": { - "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest//repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "operationId": "team-add", + "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", + "description": "A team was created.", + "operationId": "team/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team_add" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, "parameters": [ { @@ -90907,7 +92068,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-team-created" } } } @@ -90920,20 +92081,20 @@ "x-github": { "githubCloudOnly": false, "category": "webhooks", - "subcategory": "team_add", + "subcategory": "team", "supported-webhook-types": [ - "repository", "organization", + "business", "app" ] } } }, - "team-added-to-repository": { + "team-deleted": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was granted access to a repository.", - "operationId": "team/added-to-repository", + "description": "A team was deleted.", + "operationId": "team/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, @@ -91000,7 +92161,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-team-deleted" } } } @@ -91022,11 +92183,11 @@ } } }, - "team-created": { + "team-edited": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was created.", - "operationId": "team/created", + "description": "The name, description, or visibility of a team was changed.", + "operationId": "team/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, @@ -91093,7 +92254,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-edited" } } } @@ -91115,11 +92276,11 @@ } } }, - "team-deleted": { + "team-removed-from-repository": { "post": { "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team was deleted.", - "operationId": "team/deleted", + "description": "A team's access to a repository was removed.", + "operationId": "team/removed-from-repository", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" }, @@ -91186,7 +92347,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" } } } @@ -91208,13 +92369,13 @@ } } }, - "team-edited": { + "user-created": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "The name, description, or visibility of a team was changed.", - "operationId": "team/edited", + "summary": "This event occurs when there is activity relating to user accounts in an enterprise.", + "description": "A user account was added to the enterprise.", + "operationId": "user/created", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#user" }, "parameters": [ { @@ -91279,7 +92440,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-user-created" } } } @@ -91290,24 +92451,22 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "team", + "subcategory": "user", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } }, - "team-removed-from-repository": { + "user-deleted": { "post": { - "summary": "This event occurs when there is activity relating to teams in an organization.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest//organizations/organizing-members-into-teams/about-teams).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Members\" organization permission.", - "description": "A team's access to a repository was removed.", - "operationId": "team/removed-from-repository", + "summary": "This event occurs when there is activity relating to user accounts in an enterprise.", + "description": "A user account was removed from the enterprise.", + "operationId": "user/deleted", "externalDocs": { - "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#team" + "url": "https://docs.github.com/enterprise-cloud@latest//webhooks/webhook-events-and-payloads#user" }, "parameters": [ { @@ -91372,7 +92531,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-user-deleted" } } } @@ -91383,13 +92542,11 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", - "subcategory": "team", + "subcategory": "user", "supported-webhook-types": [ - "organization", - "business", - "app" + "business" ] } } @@ -101944,6 +103101,15 @@ "unknown" ] }, + "copilot_chat": { + "type": "string", + "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.", + "enum": [ + "enabled", + "disabled", + "unconfigured" + ] + }, "seat_management_setting": { "type": "string", "description": "The mode of assigning new seats.", @@ -102306,7 +103472,7 @@ "type": "object", "description": "The assignee that has been granted access to GitHub Copilot.", "additionalProperties": true, - "enum": [ + "oneOf": [ { "$ref": "#/components/schemas/simple-user" }, @@ -104004,6 +105170,104 @@ "updated_at" ] }, + "org-custom-property": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value_type": { + "type": "string", + "example": "single_select", + "enum": [ + "string", + "single_select" + ], + "description": "The type of the value for the property" + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "type": "string", + "nullable": true, + "description": "Default value of the property" + }, + "description": { + "type": "string", + "nullable": true, + "description": "Short description of the property" + }, + "allowed_values": { + "type": "array", + "items": { + "type": "string" + }, + "nullable": true, + "description": "Ordered list of allowed values of the property" + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "value": { + "type": "string", + "description": "The value assigned to the property", + "nullable": true + } + }, + "required": [ + "property_name", + "value" + ] + }, + "org-repo-custom-property-values": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", + "type": "object", + "properties": { + "repository_id": { + "type": "integer", + "example": 1296269 + }, + "repository_name": { + "type": "string", + "example": "Hello-World" + }, + "repository_full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" + } + }, + "required": [ + "repository_id", + "repository_name", + "repository_full_name", + "properties" + ] + }, "repository-rule-enforcement": { "type": "string", "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", @@ -104025,7 +105289,7 @@ "properties": { "actor_id": { "type": "integer", - "description": "The ID of the actor that can bypass a ruleset" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`." }, "actor_type": { "type": "string", @@ -104223,7 +105487,7 @@ }, "repository-rule-required-linear-history": { "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching branches.", + "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": [ "type" @@ -104239,7 +105503,7 @@ }, "repository-rule-required-deployments": { "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule.", + "description": "Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule.", "type": "object", "required": [ "type" @@ -104270,7 +105534,7 @@ }, "repository-rule-required-signatures": { "title": "required_signatures", - "description": "Commits pushed to matching branches must have verified signatures.", + "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": [ "type" @@ -104354,7 +105618,7 @@ }, "repository-rule-required-status-checks": { "title": "required_status_checks", - "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed.", + "description": "Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed.", "type": "object", "required": [ "type" @@ -104390,7 +105654,7 @@ }, "repository-rule-non-fast-forward": { "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to branches.", + "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": [ "type" @@ -104545,56 +105809,130 @@ } } }, - "repository-rule-branch-name-pattern": { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", + "repository-rule-branch-name-pattern": { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-tag-name-pattern": { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-params-workflow-file-reference": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", "type": "object", - "required": [ - "type" - ], "properties": { - "type": { + "path": { "type": "string", - "enum": [ - "branch_name_pattern" - ] + "description": "The path to the workflow file" }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" - ] + "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" + ] }, - "repository-rule-tag-name-pattern": { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", + "repository-rule-workflows": { + "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" @@ -104603,38 +105941,22 @@ "type": { "type": "string", "enum": [ - "tag_name_pattern" + "workflows" ] }, "parameters": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } } }, "required": [ - "operator", - "pattern" + "workflows" ] } } @@ -104685,6 +106007,9 @@ }, { "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" } ] }, @@ -104798,6 +106123,184 @@ } } }, + "rule-suites": { + "title": "Rule Suites", + "description": "Response", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." + }, + "actor_id": { + "type": "integer", + "description": "The number that identifies the user." + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account." + }, + "before_sha": { + "type": "string", + "description": "The first commit sha before the push evaluation." + }, + "after_sha": { + "type": "string", + "description": "The last commit sha in the push evaluation." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": "string", + "enum": [ + "pass", + "fail" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." + } + } + } + }, + "rule-suite": { + "title": "Rule Suite", + "description": "Response", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The unique identifier of the rule insight." + }, + "actor_id": { + "type": "integer", + "description": "The number that identifies the user." + }, + "actor_name": { + "type": "string", + "description": "The handle for the GitHub user account." + }, + "before_sha": { + "type": "string", + "description": "The first commit sha before the push evaluation." + }, + "after_sha": { + "type": "string", + "description": "The last commit sha in the push evaluation." + }, + "ref": { + "type": "string", + "description": "The ref name that the evaluation ran on." + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository associated with the rule evaluation." + }, + "repository_name": { + "type": "string", + "description": "The name of the repository without the `.git` extension." + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass" + ], + "description": "The result of the rule evaluations for rules with the `active` enforcement status." + }, + "evaluation_result": { + "type": "string", + "enum": [ + "pass", + "fail" + ], + "description": "The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`." + }, + "rule_evaluations": { + "type": "array", + "description": "Details on the evaluated rules.", + "items": { + "type": "object", + "properties": { + "rule_source": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of rule source." + }, + "id": { + "type": "integer", + "nullable": true, + "description": "The ID of the rule source." + }, + "name": { + "type": "string", + "nullable": true, + "description": "The name of the rule source." + } + } + }, + "enforcement": { + "type": "string", + "enum": [ + "active", + "evaluate", + "deleted ruleset" + ], + "description": "The enforcement level of this rule source." + }, + "result": { + "type": "string", + "enum": [ + "pass", + "fail" + ], + "description": "The result of the evaluation of the individual rule." + }, + "rule_type": { + "type": "string", + "description": "The type of rule." + }, + "details": { + "type": "string", + "description": "Any associated details with the rule evaluation." + } + } + } + } + } + }, "repository-advisory-vulnerability": { "description": "A product affected by the vulnerability detailed in a repository security advisory.", "type": "object", @@ -108282,7 +109785,6 @@ "forks", "forks_count", "git_url", - "has_downloads", "has_issues", "has_projects", "has_wiki", @@ -111952,6 +113454,11 @@ "type": "string", "format": "uri", "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property." + }, + "commit_oid": { + "type": "string", + "description": "The commit SHA of the repository at the time the CodeQL database was created.", + "nullable": true } }, "required": [ @@ -111979,7 +113486,7 @@ ] }, "languages": { - "description": "Languages to be analysed.", + "description": "Languages to be analyzed.", "type": "array", "items": { "type": "string", @@ -112043,7 +113550,7 @@ ] }, "languages": { - "description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`.", + "description": "CodeQL languages to be analyzed.", "type": "array", "items": { "type": "string", @@ -112244,6 +113751,21 @@ "prebuild_availability" ] }, + "codespaces-permissions-check-for-devcontainer": { + "title": "Codespaces Permissions Check", + "description": "Permission check result for a given devcontainer config.", + "type": "object", + "properties": { + "accepted": { + "description": "Whether the user has accepted the permissions defined by the devcontainer config", + "example": true, + "type": "boolean" + } + }, + "required": [ + "accepted" + ] + }, "repo-codespaces-secret": { "title": "Codespaces Secret", "description": "Set repository secrets for GitHub Codespaces.", @@ -115046,6 +116568,11 @@ "type": "string", "example": "MDQ6R2F0ZTM3NTU=" }, + "prevent_self_review": { + "type": "boolean", + "example": false, + "description": "Whether deployments to this environment can be approved by the user who created the deployment." + }, "type": { "type": "string", "example": "required_reviewers" @@ -115118,13 +116645,18 @@ "updated_at" ] }, + "prevent-self-review": { + "type": "boolean", + "example": false, + "description": "Whether or not a user who created the job is prevented from approving their own job." + }, "deployment-branch-policy": { "title": "Deployment branch policy", - "description": "Details of a deployment branch policy.", + "description": "Details of a deployment branch or tag policy.", "type": "object", "properties": { "id": { - "description": "The unique identifier of the branch policy.", + "description": "The unique identifier of the branch or tag policy.", "type": "integer", "example": 361471 }, @@ -115133,12 +116665,44 @@ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" }, "name": { - "description": "The name pattern that branches must match in order to deploy to the environment.", + "description": "The name pattern that branches or tags must match in order to deploy to the environment.", "type": "string", "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag.", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] } } }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] + } + }, + "required": [ + "name" + ] + }, "deployment-branch-policy-name-pattern": { "title": "Deployment branch policy name pattern", "type": "object", @@ -121370,6 +122934,16 @@ "$ref": "#/components/schemas/repository-rule-ruleset-info" } ] + }, + { + "allOf": [ + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-ruleset-info" + } + ] } ] }, @@ -130078,7 +131652,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", "type": "string", "nullable": true, "enum": [ @@ -130859,7 +132433,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -131633,7 +133207,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -132038,7 +133612,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -132357,7 +133931,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -132964,7 +134538,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -139457,7 +141031,7 @@ "format": "date-time" }, "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -164256,6 +165830,10 @@ "type": "string", "format": "uri" }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, "has_downloads": { "description": "Whether downloads are enabled.", "type": "boolean", @@ -164612,6 +166190,10 @@ }, "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" } }, "required": [ @@ -278764,6 +280346,248 @@ "sender" ] }, + "webhook-user-created": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "created" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "action" + ] + }, + "webhook-user-deleted": { + "type": "object", + "properties": { + "action": { + "type": "string", + "enum": [ + "deleted" + ] + }, + "enterprise": { + "$ref": "#/components/schemas/enterprise-webhooks" + }, + "installation": { + "$ref": "#/components/schemas/simple-installation" + }, + "organization": { + "$ref": "#/components/schemas/organization-simple-webhooks" + }, + "repository": { + "$ref": "#/components/schemas/repository-webhooks" + }, + "sender": { + "$ref": "#/components/schemas/simple-user-webhooks" + }, + "user": { + "title": "User", + "type": "object", + "nullable": true, + "properties": { + "avatar_url": { + "type": "string", + "format": "uri" + }, + "deleted": { + "type": "boolean" + }, + "email": { + "type": "string", + "nullable": true + }, + "events_url": { + "type": "string", + "format": "uri-template" + }, + "followers_url": { + "type": "string", + "format": "uri" + }, + "following_url": { + "type": "string", + "format": "uri-template" + }, + "gists_url": { + "type": "string", + "format": "uri-template" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "name": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "organizations_url": { + "type": "string", + "format": "uri" + }, + "received_events_url": { + "type": "string", + "format": "uri" + }, + "repos_url": { + "type": "string", + "format": "uri" + }, + "site_admin": { + "type": "boolean" + }, + "starred_url": { + "type": "string", + "format": "uri-template" + }, + "subscriptions_url": { + "type": "string", + "format": "uri" + }, + "type": { + "type": "string", + "enum": [ + "Bot", + "User", + "Organization" + ] + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "login", + "id" + ] + } + }, + "required": [ + "action" + ] + }, "webhook-watch-started": { "title": "watch started event", "type": "object", @@ -294049,6 +295873,88 @@ "updated_at": "2014-03-04T18:58:10Z" } }, + "org-custom-properties": { + "value": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + }, + "org-custom-property": { + "value": { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + }, + "org-repo-custom-property-values": { + "value": [ + { + "repository_id": 1296269, + "repository_name": "Hello-World", + "repository_full_name": "octocat/Hello-World", + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + ] + }, + "org-repo-update-custom-property-values": { + "value": { + "repository_names": [ + "Hello-World", + "octo-repo" + ], + "properties": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + } + }, "repository": { "value": { "id": 1296269, @@ -294273,6 +296179,81 @@ "updated_at": "2023-09-23T16:29:47Z" } }, + "rule-suite-items": { + "value": [ + { + "id": 21, + "actor_id": 12, + "username": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass" + }, + { + "id": 25, + "actor_id": 11, + "username": "not-octocat", + "before_sha": "48994e4e01ccc943624c6231f172702b82b233cc", + "after_sha": "ecfd5a1025fa271a33ca5608d089476a2df3c9a1", + "ref": "refs/heads/i-am-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-07T08:43:03Z", + "result": "pass", + "evaluation_result": "fail" + } + ] + }, + "rule-suite": { + "value": { + "id": 21, + "actor_id": 12, + "username": "octocat", + "before_sha": "893f768e172fb1bc9c5d6f3dd48557e45f14e01d", + "after_sha": "dedd88641a362b6b4ea872da4847d6131a164d01", + "ref": "refs/heads/i-see-everything", + "repository_id": 404, + "repository_name": "octo-repo", + "pushed_at": "2023-07-06T08:43:03Z", + "result": "bypass", + "evaluation_result": "fail", + "rule_evaluations": [ + { + "rule_source": { + "type": "ruleset", + "id": 2, + "name": "Author email must be a GitHub email address" + }, + "enforcement": "active", + "result": "pass", + "rule_type": "commit_author_email_pattern" + }, + { + "rule_source": { + "type": "protected_branch" + }, + "enforcement": "active", + "result": "fail", + "rule_type": "pull_request", + "details": "Changes must be made through a pull request." + }, + { + "rule_source": { + "type": "ruleset", + "id": 3, + "name": "Evaluate commit message pattern" + }, + "enforcement": "evaluate", + "result": "fail", + "rule_type": "commit_message_pattern" + } + ] + } + }, "list-repository-advisories": { "value": [ { @@ -296818,7 +298799,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -297492,7 +299473,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -300028,7 +302009,8 @@ "size": 1024, "created_at": "2022-09-12T12:14:32Z", "updated_at": "2022-09-12T12:14:32Z", - "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java" + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" }, { "id": 2, @@ -300058,7 +302040,8 @@ "size": 1024, "created_at": "2022-09-12T12:14:32Z", "updated_at": "2022-09-12T12:14:32Z", - "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby" + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" } ] }, @@ -300091,7 +302074,8 @@ "size": 1024, "created_at": "2022-09-12T12:14:32Z", "updated_at": "2022-09-12T12:14:32Z", - "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java" + "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java", + "commit_oid": "1927de39fefa25a9d0e64e3f540ff824a72f538c" } }, "code-scanning-default-setup": { @@ -300520,6 +302504,11 @@ } } }, + "codespaces-permissions-check-for-devcontainer": { + "value": { + "accepted": true + } + }, "collaborator-items": { "value": [ { @@ -303273,6 +305262,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -303351,6 +305341,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -303439,6 +305430,14 @@ "name": "main" } }, + "deployment-branch-policy-single-tag": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "v1", + "type": "tag" + } + }, "deployment-protection-rules": { "value": [ { @@ -305751,6 +307750,22 @@ } ] }, + "custom-property-values": { + "value": [ + { + "property_name": "environment", + "value": "production" + }, + { + "property_name": "service", + "value": "web" + }, + { + "property_name": "team", + "value": "octocat" + } + ] + }, "pull-request": { "value": { "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", @@ -316138,7 +318153,7 @@ }, "hook-id": { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "path", "required": true, "schema": { @@ -316306,6 +318321,71 @@ "type": "integer" } }, + "custom-property-name": { + "name": "custom_property_name", + "description": "The custom property name. The name is case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + "repository-name-in-query": { + "name": "repository_name", + "description": "The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned.", + "in": "query", + "schema": { + "type": "integer" + } + }, + "time-period": { + "name": "time_period", + "description": "The time period to filter by.\n\nFor example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "hour", + "day", + "week", + "month" + ], + "default": "day" + } + }, + "actor-name-in-query": { + "name": "actor_name", + "description": "The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned.", + "in": "query", + "schema": { + "type": "string" + } + }, + "rule-suite-result": { + "name": "rule_suite_result", + "description": "The rule results to filter on. When specified, only suites with this result will be returned.", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "pass", + "fail", + "bypass", + "all" + ], + "default": "all" + } + }, + "rule-suite-id": { + "name": "rule_suite_id", + "description": "The unique identifier of the rule suite result.\nTo get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites)\nfor repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites)\nfor organizations.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "secret-scanning-pagination-before-org-repo": { "name": "before", "description": "A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty \"before\" query string.", @@ -316851,6 +318931,15 @@ "type": "integer" } }, + "ref-in-query": { + "name": "ref", + "description": "The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned.", + "in": "query", + "schema": { + "type": "string" + }, + "x-multi-segment": true + }, "tag-protection-id": { "name": "tag_protection_id", "description": "The unique identifier of the tag protection.", diff --git a/cache/ghes-3.10.json b/cache/ghes-3.10.json index 2c807d380..015199c3c 100644 --- a/cache/ghes-3.10.json +++ b/cache/ghes-3.10.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "13.0.0", + "version": "13.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -4427,7 +4427,7 @@ }, "post": { "summary": "Create a new authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/about-identity-and-access-management-with-saml-single-sign-on).", + "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.10/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.10/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.10/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.10/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.10/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)\" in the GitHub Enterprise Cloud documentation.", "tags": [ "oauth-authorizations" ], @@ -17716,7 +17716,7 @@ }, "post": { "summary": "Start an organization migration", - "description": "Initiates the generation of a migration archive.", + "description": "Initiates the generation of a migration archive.\n\nBefore you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.10/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage).\"", "tags": [ "migrations" ], @@ -17786,7 +17786,7 @@ }, "exclude": { "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "items": { "type": "string", "enum": [ @@ -25626,7 +25626,7 @@ "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { "post": { "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -25917,7 +25917,7 @@ "/repos/{owner}/{repo}/actions/organization-variables": { "get": { "summary": "List repository organization variables", - "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -26390,7 +26390,7 @@ "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26462,7 +26462,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26511,7 +26511,7 @@ "/repos/{owner}/{repo}/actions/runners/generate-jitconfig": { "post": { "summary": "Create configuration for a just-in-time runner for a repository", - "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Generates a configuration that can be passed to the runner application at startup.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26605,7 +26605,7 @@ "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "tags": [ "actions" ], @@ -26651,7 +26651,7 @@ "/repos/{owner}/{repo}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "tags": [ "actions" ], @@ -26697,7 +26697,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26744,7 +26744,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26781,7 +26781,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { "get": { "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26819,7 +26819,7 @@ }, "post": { "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26894,7 +26894,7 @@ }, "put": { "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26969,7 +26969,7 @@ }, "delete": { "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27009,7 +27009,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { "delete": { "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -27552,7 +27552,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { "post": { "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -28424,7 +28424,7 @@ "/repos/{owner}/{repo}/actions/variables": { "get": { "summary": "List repository variables", - "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -28494,7 +28494,7 @@ }, "post": { "summary": "Create a repository variable", - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -28572,7 +28572,7 @@ "/repos/{owner}/{repo}/actions/variables/{name}": { "get": { "summary": "Get a repository variable", - "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -28619,7 +28619,7 @@ }, "patch": { "summary": "Update a repository variable", - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -28682,7 +28682,7 @@ }, "delete": { "summary": "Delete a repository variable", - "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -32662,7 +32662,7 @@ }, "patch": { "summary": "Update a check run", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -33335,7 +33335,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -34202,7 +34202,7 @@ } }, "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" + "$ref": "#/components/responses/code_scanning_forbidden_write" }, "404": { "$ref": "#/components/responses/not_found" @@ -35678,7 +35678,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "tags": [ "checks" ], @@ -35781,7 +35781,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "tags": [ "checks" ], @@ -38389,7 +38389,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" }, "examples": { "example-wildcard": { @@ -38446,7 +38446,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { "get": { "summary": "Get a deployment branch policy", - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -46820,7 +46820,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -52411,7 +52411,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables": { "get": { "summary": "List environment variables", - "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -52481,7 +52481,7 @@ }, "post": { "summary": "Create an environment variable", - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -52559,7 +52559,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { "get": { "summary": "Get an environment variable", - "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -52606,7 +52606,7 @@ }, "patch": { "summary": "Update an environment variable", - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -52669,7 +52669,7 @@ }, "delete": { "summary": "Delete an environment variable", - "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -86937,7 +86937,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -87044,7 +87044,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -101544,7 +101544,6 @@ "forks", "forks_count", "git_url", - "has_downloads", "has_issues", "has_projects", "has_wiki", @@ -104982,7 +104981,7 @@ ] }, "languages": { - "description": "Languages to be analysed.", + "description": "Languages to be analyzed.", "type": "array", "items": { "type": "string", @@ -105038,7 +105037,7 @@ ] }, "languages": { - "description": "CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, and `ruby`.", + "description": "CodeQL languages to be analyzed.", "type": "array", "items": { "type": "string", @@ -107861,6 +107860,20 @@ } } }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + } + }, + "required": [ + "name" + ] + }, "deployment-branch-policy-name-pattern": { "title": "Deployment branch policy name pattern", "type": "object", @@ -121546,7 +121559,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", "type": "string", "nullable": true, "enum": [ @@ -122327,7 +122340,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -123101,7 +123114,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -123506,7 +123519,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -123825,7 +123838,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -124432,7 +124445,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -130853,7 +130866,7 @@ "format": "date-time" }, "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -155682,6 +155695,10 @@ "type": "string", "format": "uri" }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, "has_downloads": { "description": "Whether downloads are enabled.", "type": "boolean", @@ -156038,6 +156055,10 @@ }, "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" } }, "required": [ @@ -279203,7 +279224,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -279877,7 +279898,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -284967,7 +284988,6 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", - "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -285045,7 +285065,6 @@ "slug": "justice-league", "description": "A great team.", "privacy": "closed", - "notification_setting": "notifications_enabled", "permission": "admin", "members_url": "https://api.github.com/teams/1/members{/member}", "repositories_url": "https://api.github.com/teams/1/repos", @@ -295511,7 +295530,7 @@ }, "hook-id": { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "path", "required": true, "schema": { diff --git a/cache/ghes-3.7.json b/cache/ghes-3.7.json index a4dc828a1..593741c1a 100644 --- a/cache/ghes-3.7.json +++ b/cache/ghes-3.7.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "13.0.0", + "version": "13.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -4427,7 +4427,7 @@ }, "post": { "summary": "Create a new authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.7/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.7/articles/about-identity-and-access-management-with-saml-single-sign-on).", + "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.7/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.7/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.7/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.7/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.7/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.7/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)\" in the GitHub Enterprise Cloud documentation.", "tags": [ "oauth-authorizations" ], @@ -15794,7 +15794,7 @@ }, "exclude": { "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "items": { "type": "string", "enum": [ @@ -22399,7 +22399,7 @@ "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { "post": { "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -23008,7 +23008,7 @@ "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23080,7 +23080,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23129,7 +23129,7 @@ "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "tags": [ "actions" ], @@ -23175,7 +23175,7 @@ "/repos/{owner}/{repo}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "tags": [ "actions" ], @@ -23221,7 +23221,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23268,7 +23268,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23305,7 +23305,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { "get": { "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23343,7 +23343,7 @@ }, "post": { "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23418,7 +23418,7 @@ }, "put": { "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23493,7 +23493,7 @@ }, "delete": { "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -23533,7 +23533,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { "delete": { "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24076,7 +24076,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { "post": { "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -28770,7 +28770,7 @@ }, "patch": { "summary": "Update a check run", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -29443,7 +29443,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -31621,7 +31621,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "tags": [ "checks" ], @@ -31724,7 +31724,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "tags": [ "checks" ], @@ -33984,7 +33984,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" }, "examples": { "example-wildcard": { @@ -34041,7 +34041,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { "get": { "summary": "Get a deployment branch policy", - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -42090,7 +42090,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -79267,7 +79267,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -79374,7 +79374,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -91963,7 +91963,6 @@ "forks", "forks_count", "git_url", - "has_downloads", "has_issues", "has_projects", "has_wiki", @@ -97713,6 +97712,20 @@ } } }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + } + }, + "required": [ + "name" + ] + }, "deployment-branch-policy-name-pattern": { "title": "Deployment branch policy name pattern", "type": "object", @@ -111364,7 +111377,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", "type": "string", "nullable": true, "enum": [ @@ -112145,7 +112158,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -112919,7 +112932,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -113324,7 +113337,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -113643,7 +113656,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -114250,7 +114263,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -120625,7 +120638,7 @@ "format": "date-time" }, "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -145382,6 +145395,10 @@ "type": "string", "format": "uri" }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, "has_downloads": { "description": "Whether downloads are enabled.", "type": "boolean", @@ -145738,6 +145755,10 @@ }, "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" } }, "required": [ @@ -267241,7 +267262,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -267874,7 +267895,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -282601,7 +282622,7 @@ }, "hook-id": { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "path", "required": true, "schema": { diff --git a/cache/ghes-3.8.json b/cache/ghes-3.8.json index d46e332be..ed94ebca4 100644 --- a/cache/ghes-3.8.json +++ b/cache/ghes-3.8.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "13.0.0", + "version": "13.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -4427,7 +4427,7 @@ }, "post": { "summary": "Create a new authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/about-identity-and-access-management-with-saml-single-sign-on).", + "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.8/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.8/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.8/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.8/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.8/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)\" in the GitHub Enterprise Cloud documentation.", "tags": [ "oauth-authorizations" ], @@ -16760,7 +16760,7 @@ }, "post": { "summary": "Start an organization migration", - "description": "Initiates the generation of a migration archive.", + "description": "Initiates the generation of a migration archive.\n\nBefore you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.8/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage).\"", "tags": [ "migrations" ], @@ -16830,7 +16830,7 @@ }, "exclude": { "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "items": { "type": "string", "enum": [ @@ -23452,7 +23452,7 @@ "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { "post": { "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -24072,7 +24072,7 @@ "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24144,7 +24144,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24193,7 +24193,7 @@ "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "tags": [ "actions" ], @@ -24239,7 +24239,7 @@ "/repos/{owner}/{repo}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "tags": [ "actions" ], @@ -24285,7 +24285,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24332,7 +24332,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24369,7 +24369,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { "get": { "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24407,7 +24407,7 @@ }, "post": { "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24482,7 +24482,7 @@ }, "put": { "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24557,7 +24557,7 @@ }, "delete": { "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -24597,7 +24597,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { "delete": { "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25140,7 +25140,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { "post": { "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -25948,7 +25948,7 @@ "/repos/{owner}/{repo}/actions/variables": { "get": { "summary": "List repository variables", - "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -26018,7 +26018,7 @@ }, "post": { "summary": "Create a repository variable", - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -26096,7 +26096,7 @@ "/repos/{owner}/{repo}/actions/variables/{name}": { "get": { "summary": "Get a repository variable", - "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -26143,7 +26143,7 @@ }, "patch": { "summary": "Update a repository variable", - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -26206,7 +26206,7 @@ }, "delete": { "summary": "Delete a repository variable", - "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -30153,7 +30153,7 @@ }, "patch": { "summary": "Update a check run", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -30826,7 +30826,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -33020,7 +33020,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "tags": [ "checks" ], @@ -33123,7 +33123,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "tags": [ "checks" ], @@ -35675,7 +35675,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" }, "examples": { "example-wildcard": { @@ -35732,7 +35732,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { "get": { "summary": "Get a deployment branch policy", - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -43787,7 +43787,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -49269,7 +49269,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables": { "get": { "summary": "List environment variables", - "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -49339,7 +49339,7 @@ }, "post": { "summary": "Create an environment variable", - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -49417,7 +49417,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { "get": { "summary": "Get an environment variable", - "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -49464,7 +49464,7 @@ }, "patch": { "summary": "Update an environment variable", - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -49527,7 +49527,7 @@ }, "delete": { "summary": "Delete an environment variable", - "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -81285,7 +81285,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -81392,7 +81392,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -94603,7 +94603,6 @@ "forks", "forks_count", "git_url", - "has_downloads", "has_issues", "has_projects", "has_wiki", @@ -100578,6 +100577,20 @@ } } }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + } + }, + "required": [ + "name" + ] + }, "deployment-branch-policy-name-pattern": { "title": "Deployment branch policy name pattern", "type": "object", @@ -113924,7 +113937,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", "type": "string", "nullable": true, "enum": [ @@ -114705,7 +114718,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -115479,7 +115492,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -115884,7 +115897,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -116203,7 +116216,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -116810,7 +116823,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -123185,7 +123198,7 @@ "format": "date-time" }, "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -147942,6 +147955,10 @@ "type": "string", "format": "uri" }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, "has_downloads": { "description": "Whether downloads are enabled.", "type": "boolean", @@ -148298,6 +148315,10 @@ }, "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" } }, "required": [ @@ -270439,7 +270460,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -271077,7 +271098,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -286317,7 +286338,7 @@ }, "hook-id": { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "path", "required": true, "schema": { diff --git a/cache/ghes-3.9.json b/cache/ghes-3.9.json index bfa2a1cad..ae7089b21 100644 --- a/cache/ghes-3.9.json +++ b/cache/ghes-3.9.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "13.0.0", + "version": "13.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -4431,7 +4431,7 @@ }, "post": { "summary": "Create a new authorization", - "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/about-identity-and-access-management-with-saml-single-sign-on).", + "description": "**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).\n\n**Warning:** Apps must use the [web application flow](https://docs.github.com/enterprise-server@3.9/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub Enterprise Server SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub Enterprise Server SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see \"[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.9/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)\" in the GitHub Enterprise Cloud documentation.", "tags": [ "oauth-authorizations" ], @@ -17348,7 +17348,7 @@ }, "post": { "summary": "Start an organization migration", - "description": "Initiates the generation of a migration archive.", + "description": "Initiates the generation of a migration archive.\n\nBefore you can use this endpoint, you must configure a blob storage provider in the \"Migrations\" section in the Management Console. For more details, see \"[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage).\"", "tags": [ "migrations" ], @@ -17418,7 +17418,7 @@ }, "exclude": { "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "items": { "type": "string", "enum": [ @@ -24566,7 +24566,7 @@ "/repos/{owner}/{repo}/actions/jobs/{job_id}/rerun": { "post": { "summary": "Re-run a job from a workflow run", - "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Re-run a job and its dependent jobs in a workflow run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -24857,7 +24857,7 @@ "/repos/{owner}/{repo}/actions/organization-variables": { "get": { "summary": "List repository organization variables", - "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all organiation variables shared with a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -25330,7 +25330,7 @@ "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25402,7 +25402,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25451,7 +25451,7 @@ "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "tags": [ "actions" ], @@ -25497,7 +25497,7 @@ "/repos/{owner}/{repo}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "tags": [ "actions" ], @@ -25543,7 +25543,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25590,7 +25590,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25627,7 +25627,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels": { "get": { "summary": "List labels for a self-hosted runner for a repository", - "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all labels for a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25665,7 +25665,7 @@ }, "post": { "summary": "Add custom labels to a self-hosted runner for a repository", - "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Add custom labels to a self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25740,7 +25740,7 @@ }, "put": { "summary": "Set custom labels for a self-hosted runner for a repository", - "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all previous custom labels and set the new custom labels for a specific\nself-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25815,7 +25815,7 @@ }, "delete": { "summary": "Remove all custom labels from a self-hosted runner for a repository", - "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove all custom labels from a self-hosted runner configured in a\nrepository. Returns the remaining read-only labels from the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -25855,7 +25855,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}": { "delete": { "summary": "Remove a custom label from a self-hosted runner for a repository", - "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Remove a custom label from a self-hosted runner configured\nin a repository. Returns the remaining labels from the runner.\n\nThis endpoint returns a `404 Not Found` status if the custom label is not\npresent on the runner.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -26398,7 +26398,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { "post": { "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -27206,7 +27206,7 @@ "/repos/{owner}/{repo}/actions/variables": { "get": { "summary": "List repository variables", - "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all repository variables.\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -27276,7 +27276,7 @@ }, "post": { "summary": "Create a repository variable", - "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Creates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -27354,7 +27354,7 @@ "/repos/{owner}/{repo}/actions/variables/{name}": { "get": { "summary": "Get a repository variable", - "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -27401,7 +27401,7 @@ }, "patch": { "summary": "Update a repository variable", - "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates a repository variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -27464,7 +27464,7 @@ }, "delete": { "summary": "Delete a repository variable", - "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes a repository variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions_variables:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -31392,7 +31392,7 @@ }, "patch": { "summary": "Update a check run", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -32065,7 +32065,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -32924,7 +32924,7 @@ } }, "403": { - "$ref": "#/components/responses/code_scanning_forbidden_read" + "$ref": "#/components/responses/code_scanning_forbidden_write" }, "404": { "$ref": "#/components/responses/not_found" @@ -34400,7 +34400,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "tags": [ "checks" ], @@ -34503,7 +34503,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "tags": [ "checks" ], @@ -37111,7 +37111,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" }, "examples": { "example-wildcard": { @@ -37168,7 +37168,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { "get": { "summary": "Get a deployment branch policy", - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -45223,7 +45223,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -50814,7 +50814,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables": { "get": { "summary": "List environment variables", - "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Lists all environment variables.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -50884,7 +50884,7 @@ }, "post": { "summary": "Create an environment variable", - "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Create an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -50962,7 +50962,7 @@ "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { "get": { "summary": "Get an environment variable", - "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Gets a specific variable in an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environments:read` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -51009,7 +51009,7 @@ }, "patch": { "summary": "Update an environment variable", - "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Updates an environment variable that you can reference in a GitHub Actions workflow.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -51072,7 +51072,7 @@ }, "delete": { "summary": "Delete an environment variable", - "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", + "description": "Deletes an environment variable using the variable name.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `environment:write` repository permission to use this endpoint.\nAuthenticated users must have collaborator access to a repository to create, update, or read variables.", "tags": [ "actions" ], @@ -84857,7 +84857,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -84964,7 +84964,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -99094,7 +99094,6 @@ "forks", "forks_count", "git_url", - "has_downloads", "has_issues", "has_projects", "has_wiki", @@ -102466,7 +102465,7 @@ ] }, "languages": { - "description": "Languages to be analysed.", + "description": "Languages to be analyzed.", "type": "array", "items": { "type": "string", @@ -105329,6 +105328,20 @@ } } }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + } + }, + "required": [ + "name" + ] + }, "deployment-branch-policy-name-pattern": { "title": "Deployment branch policy name pattern", "type": "object", @@ -118771,7 +118784,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", "type": "string", "nullable": true, "enum": [ @@ -119552,7 +119565,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -120326,7 +120339,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -120731,7 +120744,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -121050,7 +121063,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -121657,7 +121670,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -128032,7 +128045,7 @@ "format": "date-time" }, "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -152861,6 +152874,10 @@ "type": "string", "format": "uri" }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, "has_downloads": { "description": "Whether downloads are enabled.", "type": "boolean", @@ -153217,6 +153234,10 @@ }, "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" } }, "required": [ @@ -275930,7 +275951,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -276604,7 +276625,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -292151,7 +292172,7 @@ }, "hook-id": { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "path", "required": true, "schema": { diff --git a/cache/github.ae.json b/cache/github.ae.json index 360de838e..ae08058eb 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "13.0.0", + "version": "13.1.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -11635,7 +11635,7 @@ }, "exclude": { "type": "array", - "description": "Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `\"repositories\"`.", + "description": "Exclude related items from being returned in the response in order to improve performance of the request.", "items": { "type": "string", "enum": [ @@ -17528,7 +17528,7 @@ "/repos/{owner}/{repo}/actions/runners": { "get": { "summary": "List self-hosted runners for a repository", - "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists all self-hosted runners configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -17600,7 +17600,7 @@ "/repos/{owner}/{repo}/actions/runners/downloads": { "get": { "summary": "List runner applications for a repository", - "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Lists binaries for the runner application that you can download and run.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -17649,7 +17649,7 @@ "/repos/{owner}/{repo}/actions/runners/registration-token": { "post": { "summary": "Create a registration token for a repository", - "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token: \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", + "description": "Returns a token that you can pass to the `config` script. The token\nexpires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using registration token:\n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration token provided\nby this endpoint.\n\n```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN```", "tags": [ "actions" ], @@ -17695,7 +17695,7 @@ "/repos/{owner}/{repo}/actions/runners/remove-token": { "post": { "summary": "Create a remove token for a repository", - "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", + "description": "Returns a token that you can pass to remove a self-hosted runner from\na repository. The token expires after one hour.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.\n\nExample using remove token:\n\nTo remove your self-hosted runner from a repository, replace TOKEN with\nthe remove token provided by this endpoint.\n\n```config.sh remove --token TOKEN```", "tags": [ "actions" ], @@ -17741,7 +17741,7 @@ "/repos/{owner}/{repo}/actions/runners/{runner_id}": { "get": { "summary": "Get a self-hosted runner for a repository", - "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Gets a specific self-hosted runner configured in a repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -17788,7 +17788,7 @@ }, "delete": { "summary": "Delete a self-hosted runner from a repository", - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations.\nAuthenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints.", "tags": [ "actions" ], @@ -18270,7 +18270,7 @@ "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { "post": { "summary": "Cancel a workflow run", - "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nIf the repository is private, you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "description": "Cancels a workflow run using its `id`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ "actions" ], @@ -18319,6 +18319,58 @@ "x-octokit": {} } }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + "post": { + "summary": "Force cancel a workflow run", + "description": "Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job.\nYou should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run).\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint.\nGitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/force-cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/actions/workflow-runs#force-cancel-a-workflow-run" + }, + "parameters": [ + { + "$ref": "#/components/parameters/owner" + }, + { + "$ref": "#/components/parameters/repo" + }, + { + "$ref": "#/components/parameters/run-id" + } + ], + "responses": { + "202": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/empty-object" + }, + "examples": { + "default": { + "value": null + } + } + } + } + }, + "409": { + "$ref": "#/components/responses/conflict" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "actions", + "subcategory": "workflow-runs" + }, + "x-octokit": {} + } + }, "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { "get": { "summary": "List jobs for a workflow run", @@ -22724,7 +22776,7 @@ }, "patch": { "summary": "Update a check run", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -23397,7 +23449,7 @@ "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.", "tags": [ "checks" ], @@ -25620,7 +25672,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-runs": { "get": { "summary": "List check runs for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "description": "Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nIf there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.", "tags": [ "checks" ], @@ -25723,7 +25775,7 @@ "/repos/{owner}/{repo}/commits/{ref}/check-suites": { "get": { "summary": "List check suites for a Git reference", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "description": "Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.\n\n**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.", "tags": [ "checks" ], @@ -27332,6 +27384,9 @@ "wait_timer": { "$ref": "#/components/schemas/wait-timer" }, + "prevent_self_review": { + "$ref": "#/components/schemas/prevent-self-review" + }, "reviewers": { "type": "array", "nullable": true, @@ -27360,6 +27415,7 @@ "default": { "value": { "wait_timer": 30, + "prevent_self_review": false, "reviewers": [ { "type": "User", @@ -27524,7 +27580,7 @@ }, "post": { "summary": "Create a deployment branch policy", - "description": "Creates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Creates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -27549,7 +27605,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/deployment-branch-policy-name-pattern" + "$ref": "#/components/schemas/deployment-branch-policy-name-pattern-with-type" }, "examples": { "example-wildcard": { @@ -27561,7 +27617,15 @@ "example-single-branch": { "summary": "Example of a single branch name pattern", "value": { - "name": "main" + "name": "main", + "type": "branch" + } + }, + "example-single-tag": { + "summary": "Example of a single tag name pattern", + "value": { + "name": "v1", + "type": "tag" } } } @@ -27582,6 +27646,9 @@ }, "example-single-branch": { "$ref": "#/components/examples/deployment-branch-policy-single-branch" + }, + "example-single-tag": { + "$ref": "#/components/examples/deployment-branch-policy-single-tag" } } } @@ -27606,7 +27673,7 @@ "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { "get": { "summary": "Get a deployment branch policy", - "description": "Gets a deployment branch policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "description": "Gets a deployment branch or tag policy for an environment.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ "repos" ], @@ -27656,7 +27723,7 @@ }, "put": { "summary": "Update a deployment branch policy", - "description": "Updates a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Updates a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -27723,7 +27790,7 @@ }, "delete": { "summary": "Delete a deployment branch policy", - "description": "Deletes a deployment branch policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", + "description": "Deletes a deployment branch or tag policy for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint.", "tags": [ "repos" ], @@ -35344,7 +35411,7 @@ "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { "get": { "summary": "List reactions for a pull request review comment", - "description": "List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/pulls/comments#get-a-review-comment-for-a-pull-request).", + "description": "List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request).", "tags": [ "reactions" ], @@ -64820,7 +64887,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -64911,7 +64978,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "category": "webhooks", "subcategory": "user", "supported-webhook-types": [ @@ -76337,7 +76404,6 @@ "forks", "forks_count", "git_url", - "has_downloads", "has_issues", "has_projects", "has_wiki", @@ -81565,6 +81631,11 @@ "type": "string", "example": "MDQ6R2F0ZTM3NTU=" }, + "prevent_self_review": { + "type": "boolean", + "example": false, + "description": "Whether deployments to this environment can be approved by the user who created the deployment." + }, "type": { "type": "string", "example": "required_reviewers" @@ -81637,13 +81708,18 @@ "updated_at" ] }, + "prevent-self-review": { + "type": "boolean", + "example": false, + "description": "Whether or not a user who created the job is prevented from approving their own job." + }, "deployment-branch-policy": { "title": "Deployment branch policy", - "description": "Details of a deployment branch policy.", + "description": "Details of a deployment branch or tag policy.", "type": "object", "properties": { "id": { - "description": "The unique identifier of the branch policy.", + "description": "The unique identifier of the branch or tag policy.", "type": "integer", "example": 361471 }, @@ -81652,12 +81728,44 @@ "example": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=" }, "name": { - "description": "The name pattern that branches must match in order to deploy to the environment.", + "description": "The name pattern that branches or tags must match in order to deploy to the environment.", "type": "string", "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag.", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] } } }, + "deployment-branch-policy-name-pattern-with-type": { + "title": "Deployment branch and tag policy name pattern", + "type": "object", + "properties": { + "name": { + "description": "The name pattern that branches or tags must match in order to deploy to the environment.\n\nWildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.\nFor more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).", + "type": "string", + "example": "release/*" + }, + "type": { + "description": "Whether this rule targets a branch or tag", + "type": "string", + "example": "branch", + "enum": [ + "branch", + "tag" + ] + } + }, + "required": [ + "name" + ] + }, "deployment-branch-policy-name-pattern": { "title": "Deployment branch policy name pattern", "type": "object", @@ -94181,7 +94289,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`.", "type": "string", "nullable": true, "enum": [ @@ -94962,7 +95070,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -95736,7 +95844,7 @@ "format": "uri" }, "conclusion": { - "description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -96141,7 +96249,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -96460,7 +96568,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -97067,7 +97175,7 @@ ] }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert.", "type": "string", "nullable": true, "enum": [ @@ -103560,7 +103668,7 @@ "format": "date-time" }, "conclusion": { - "description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed.", + "description": "The result of the completed check run. This value will be `null` until the check run has completed.", "type": "string", "nullable": true, "enum": [ @@ -128287,6 +128395,10 @@ "type": "string", "format": "uri" }, + "has_discussions": { + "description": "Whether the repository has discussions enabled.", + "type": "boolean" + }, "has_downloads": { "description": "Whether downloads are enabled.", "type": "boolean", @@ -128643,6 +128755,10 @@ }, "watchers_count": { "type": "integer" + }, + "web_commit_signoff_required": { + "description": "Whether to require commit signoff.", + "type": "boolean" } }, "required": [ @@ -247417,7 +247533,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -248019,7 +248135,7 @@ "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", - "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/29679449/jobs/399444496", "status": "completed", "conclusion": "success", "started_at": "2020-01-20T17:42:40Z", @@ -252299,6 +252415,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -252377,6 +252494,7 @@ { "id": 3755, "node_id": "MDQ6R2F0ZTM3NTU=", + "prevent_self_review": false, "type": "required_reviewers", "reviewers": [ { @@ -252465,6 +252583,14 @@ "name": "main" } }, + "deployment-branch-policy-single-tag": { + "value": { + "id": 364663, + "node_id": "MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjM=", + "name": "v1", + "type": "tag" + } + }, "repo-events-items": { "value": [ { @@ -261653,7 +261779,7 @@ }, "hook-id": { "name": "hook_id", - "description": "The unique identifier of the hook.", + "description": "The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.", "in": "path", "required": true, "schema": { diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json index ed6a7be71..de3e8f6c4 100644 --- a/packages/openapi-types-ghec/package.json +++ b/packages/openapi-types-ghec/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "13.0.0" + "openapi-version": "13.1.0" } } diff --git a/packages/openapi-types-ghec/types.d.ts b/packages/openapi-types-ghec/types.d.ts index e21750729..ecf46a2e1 100644 --- a/packages/openapi-types-ghec/types.d.ts +++ b/packages/openapi-types-ghec/types.d.ts @@ -2553,7 +2553,7 @@ export interface paths { * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - get: operations["copilot/get-copilot-seat-assignment-details-for-user"]; + get: operations["copilot/get-copilot-seat-details-for-user"]; }; "/orgs/{org}/memberships/{username}": { /** @@ -2827,6 +2827,60 @@ export interface paths { */ post: operations["projects/create-for-org"]; }; + "/orgs/{org}/properties/schema": { + /** + * Get all custom properties for an organization + * @description Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-all-custom-properties"]; + /** + * Create or update custom properties for an organization + * @description Creates new or updates existing custom properties defined for an organization in a batch. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties"]; + }; + "/orgs/{org}/properties/schema/{custom_property_name}": { + /** + * Get a custom property for an organization + * @description Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-custom-property"]; + /** + * Create or update a custom property for an organization + * @description Creates a new or updates an existing custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + put: operations["orgs/create-or-update-custom-property"]; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + delete: operations["orgs/remove-custom-property"]; + }; + "/orgs/{org}/properties/values": { + /** + * List custom property values for organization repositories + * @description Lists organization repositories with all of their custom property values. + * Organization members can read these properties. + */ + get: operations["orgs/list-custom-properties-values-for-repos"]; + /** + * Create or update custom property values for organization repositories + * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + }; "/orgs/{org}/public_members": { /** * List public organization members @@ -2896,6 +2950,22 @@ export interface paths { */ post: operations["repos/create-org-ruleset"]; }; + "/orgs/{org}/rulesets/rule-suites": { + /** + * List organization rule suites + * @description Lists suites of rule evaluations at the organization level. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-org-rule-suites"]; + }; + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + /** + * Get an organization rule suite + * @description Gets information about a suite of rule evaluations from within an organization. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-org-rule-suite"]; + }; "/orgs/{org}/rulesets/{ruleset_id}": { /** * Get an organization repository ruleset @@ -3617,7 +3687,6 @@ export interface paths { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; @@ -3656,7 +3725,6 @@ export interface paths { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3750,7 +3818,6 @@ export interface paths { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3762,7 +3829,6 @@ export interface paths { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3774,7 +3840,6 @@ export interface paths { * @description Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3787,7 +3852,6 @@ export interface paths { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3807,7 +3871,6 @@ export interface paths { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3826,7 +3889,6 @@ export interface paths { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3836,7 +3898,6 @@ export interface paths { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3848,7 +3909,6 @@ export interface paths { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3859,7 +3919,6 @@ export interface paths { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3869,7 +3928,6 @@ export interface paths { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3880,7 +3938,6 @@ export interface paths { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3896,7 +3953,6 @@ export interface paths { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3981,7 +4037,6 @@ export interface paths { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; @@ -3999,6 +4054,17 @@ export interface paths { */ post: operations["actions/review-custom-gates-for-run"]; }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + /** + * Force cancel a workflow run + * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + post: operations["actions/force-cancel-workflow-run"]; + }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { /** * List jobs for a workflow run @@ -4120,7 +4186,6 @@ export interface paths { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -4130,7 +4195,6 @@ export interface paths { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -4142,7 +4206,6 @@ export interface paths { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -4152,7 +4215,6 @@ export interface paths { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -4162,7 +4224,6 @@ export interface paths { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -4235,7 +4296,7 @@ export interface paths { * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * * For more information about viewing repository activity, - * see "[Viewing repository activity](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." */ get: operations["repos/list-activities"]; }; @@ -4605,9 +4666,9 @@ export interface paths { get: operations["checks/get"]; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; }; @@ -4657,9 +4718,9 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; }; @@ -4979,6 +5040,17 @@ export interface paths { */ get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; }; + "/repos/{owner}/{repo}/codespaces/permissions_check": { + /** + * Check if permissions defined by a devcontainer have been accepted by the authenticated user + * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + get: operations["codespaces/check-permissions-for-devcontainer"]; + }; "/repos/{owner}/{repo}/codespaces/secrets": { /** * List repository secrets @@ -5254,18 +5326,20 @@ export interface paths { "/repos/{owner}/{repo}/commits/{ref}/check-runs": { /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; }; @@ -5302,10 +5376,8 @@ export interface paths { * README, and CONTRIBUTING files. * * The `health_percentage` score is defined as a percentage of how many of - * these four documents are present: README, CONTRIBUTING, LICENSE, and - * CODE_OF_CONDUCT. For example, if all four documents are present, then - * the `health_percentage` is `100`. If only one is present, then the - * `health_percentage` is `25`. + * the recommended community health files are present. For more information, see + * "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." * * `content_reports_enabled` is only returned for organization-owned repositories. */ @@ -5676,7 +5748,7 @@ export interface paths { get: operations["repos/list-deployment-branch-policies"]; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -5685,21 +5757,21 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -6068,11 +6140,10 @@ export interface paths { "/repos/{owner}/{repo}/import": { /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -6110,21 +6181,25 @@ export interface paths { get: operations["migrations/get-import-status"]; /** * Start an import - * @description Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. + * Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -6132,60 +6207,54 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; }; "/repos/{owner}/{repo}/import/authors": { /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; }; "/repos/{owner}/{repo}/import/authors/{author_id}": { /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; }; "/repos/{owner}/{repo}/import/large_files": { /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; }; "/repos/{owner}/{repo}/import/lfs": { /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; }; @@ -6691,6 +6760,14 @@ export interface paths { */ post: operations["projects/create-for-repo"]; }; + "/repos/{owner}/{repo}/properties/values": { + /** + * Get all custom property values for a repository + * @description Gets all custom property values that are set for a repository. + * Users with admin access to the repository can use this endpoint. + */ + get: operations["repos/get-custom-properties-values"]; + }; "/repos/{owner}/{repo}/pulls": { /** * List pull requests @@ -6734,7 +6811,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** @@ -7084,6 +7161,22 @@ export interface paths { */ post: operations["repos/create-repo-ruleset"]; }; + "/repos/{owner}/{repo}/rulesets/rule-suites": { + /** + * List repository rule suites + * @description Lists suites of rule evaluations at the repository level. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-repo-rule-suites"]; + }; + "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + /** + * Get a repository rule suite + * @description Gets information about a suite of rule evaluations from within a repository. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-repo-rule-suite"]; + }; "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { /** * Get a repository ruleset @@ -7508,7 +7601,6 @@ export interface paths { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -7518,7 +7610,6 @@ export interface paths { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -7530,7 +7621,6 @@ export interface paths { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -7540,7 +7630,6 @@ export interface paths { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -7550,7 +7639,6 @@ export interface paths { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -14526,6 +14614,11 @@ export interface components { * @enum {string} */ public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @enum {string} + */ + copilot_chat?: "enabled" | "disabled" | "unconfigured"; /** * @description The mode of assigning new seats. * @enum {string} @@ -14716,10 +14809,7 @@ export interface components { * @description Information about a Copilot for Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** - * @description The assignee that has been granted access to GitHub Copilot. - * @enum {object} - */ + /** @description The assignee that has been granted access to GitHub Copilot. */ assignee: { [key: string]: unknown; } & ( @@ -15671,6 +15761,52 @@ export interface components { /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ private?: boolean; }; + /** + * Organization Custom Property + * @description Custom property defined on an organization + */ + "org-custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + /** + * Custom Property Value + * @description Custom property name and associated value + */ + "custom-property-value": { + /** @description The name of the property */ + property_name: string; + /** @description The value assigned to the property */ + value: string | null; + }; + /** + * Organization Repository Custom Property Values + * @description List of custom property values for a repository + */ + "org-repo-custom-property-values": { + /** @example 1296269 */ + repository_id: number; + /** @example Hello-World */ + repository_name: string; + /** @example octocat/Hello-World */ + repository_full_name: string; + /** @description List of custom property names and associated values */ + properties: components["schemas"]["custom-property-value"][]; + }; /** * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. * @enum {string} @@ -15681,7 +15817,7 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ actor_id: number; /** * @description The type of actor that can bypass a ruleset @@ -15773,7 +15909,7 @@ export interface components { }; /** * required_linear_history - * @description Prevent merge commits from being pushed to matching branches. + * @description Prevent merge commits from being pushed to matching refs. */ "repository-rule-required-linear-history": { /** @enum {string} */ @@ -15781,7 +15917,7 @@ export interface components { }; /** * required_deployments - * @description Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. + * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule. */ "repository-rule-required-deployments": { /** @enum {string} */ @@ -15793,7 +15929,7 @@ export interface components { }; /** * required_signatures - * @description Commits pushed to matching branches must have verified signatures. + * @description Commits pushed to matching refs must have verified signatures. */ "repository-rule-required-signatures": { /** @enum {string} */ @@ -15831,7 +15967,7 @@ export interface components { }; /** * required_status_checks - * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. + * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed. */ "repository-rule-required-status-checks": { /** @enum {string} */ @@ -15845,7 +15981,7 @@ export interface components { }; /** * non_fast_forward - * @description Prevent users with push access from force pushing to branches. + * @description Prevent users with push access from force pushing to refs. */ "repository-rule-non-fast-forward": { /** @enum {string} */ @@ -15956,6 +16092,32 @@ export interface components { pattern: string; }; }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + ref?: string; + /** @description The ID of the repository where the workflow is defined */ + repository_id: number; + /** @description The commit SHA of the workflow file to use */ + sha?: string; + }; + /** + * workflows + * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ + "repository-rule-workflows": { + /** @enum {string} */ + type: "workflows"; + parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; /** * Repository Rule * @description A repository rule. @@ -15974,7 +16136,8 @@ export interface components { | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] - | components["schemas"]["repository-rule-tag-name-pattern"]; + | components["schemas"]["repository-rule-tag-name-pattern"] + | components["schemas"]["repository-rule-workflows"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -16025,6 +16188,105 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** + * Rule Suites + * @description Response + */ + "rule-suites": { + /** @description The unique identifier of the rule insight. */ + id?: number; + /** @description The number that identifies the user. */ + actor_id?: number; + /** @description The handle for the GitHub user account. */ + actor_name?: string; + /** @description The first commit sha before the push evaluation. */ + before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + repository_name?: string; + /** + * Format: date-time + * @example 2011-01-26T19:06:43Z + */ + pushed_at?: string; + /** + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} + */ + result?: "pass" | "fail" | "bypass"; + /** + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} + */ + evaluation_result?: "pass" | "fail"; + }[]; + /** + * Rule Suite + * @description Response + */ + "rule-suite": { + /** @description The unique identifier of the rule insight. */ + id?: number; + /** @description The number that identifies the user. */ + actor_id?: number; + /** @description The handle for the GitHub user account. */ + actor_name?: string; + /** @description The first commit sha before the push evaluation. */ + before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + repository_name?: string; + /** + * Format: date-time + * @example 2011-01-26T19:06:43Z + */ + pushed_at?: string; + /** + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} + */ + result?: "pass" | "fail" | "bypass"; + /** + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} + */ + evaluation_result?: "pass" | "fail"; + /** @description Details on the evaluated rules. */ + rule_evaluations?: { + rule_source?: { + /** @description The type of rule source. */ + type?: string; + /** @description The ID of the rule source. */ + id?: number | null; + /** @description The name of the rule source. */ + name?: string | null; + }; + /** + * @description The enforcement level of this rule source. + * @enum {string} + */ + enforcement?: "active" | "evaluate" | "deleted ruleset"; + /** + * @description The result of the evaluation of the individual rule. + * @enum {string} + */ + result?: "pass" | "fail"; + /** @description The type of rule. */ + rule_type?: string; + /** @description Any associated details with the rule evaluation. */ + details?: string; + }[]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ @@ -17838,7 +18100,7 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** @example true */ has_discussions: boolean; archived: boolean; @@ -19774,6 +20036,8 @@ export interface components { * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. */ url: string; + /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + commit_oid?: string | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { @@ -19782,7 +20046,7 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; - /** @description Languages to be analysed. */ + /** @description Languages to be analyzed. */ languages?: ( | "c-cpp" | "csharp" @@ -19824,7 +20088,7 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; - /** @description CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`. */ + /** @description CodeQL languages to be analyzed. */ languages?: ( | "c-cpp" | "csharp" @@ -19958,6 +20222,17 @@ export interface components { */ prebuild_availability: "none" | "ready" | "in_progress" | null; }; + /** + * Codespaces Permissions Check + * @description Permission check result for a given devcontainer config. + */ + "codespaces-permissions-check-for-devcontainer": { + /** + * @description Whether the user has accepted the permissions defined by the devcontainer config + * @example true + */ + accepted: boolean; + }; /** * Codespaces Secret * @description Set repository secrets for GitHub Codespaces. @@ -21242,6 +21517,11 @@ export interface components { id: number; /** @example MDQ6R2F0ZTM3NTU= */ node_id: string; + /** + * @description Whether deployments to this environment can be approved by the user who created the deployment. + * @example false + */ + prevent_self_review?: boolean; /** @example required_reviewers */ type: string; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ @@ -21263,23 +21543,51 @@ export interface components { )[]; deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; }; + /** + * @description Whether or not a user who created the job is prevented from approving their own job. + * @example false + */ + "prevent-self-review": boolean; /** * Deployment branch policy - * @description Details of a deployment branch policy. + * @description Details of a deployment branch or tag policy. */ "deployment-branch-policy": { /** - * @description The unique identifier of the branch policy. + * @description The unique identifier of the branch or tag policy. * @example 361471 */ id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ node_id?: string; /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ name?: string; + /** + * @description Whether this rule targets a branch or tag. + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; + }; + /** Deployment branch and tag policy name pattern */ + "deployment-branch-policy-name-pattern-with-type": { + /** + * @description The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example release/* + */ + name: string; + /** + * @description Whether this rule targets a branch or tag + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { @@ -23909,6 +24217,8 @@ export interface components { | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; @@ -27991,7 +28301,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: @@ -28302,7 +28612,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -28601,7 +28911,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -28759,7 +29069,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -28891,7 +29201,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -29127,7 +29437,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -31424,7 +31734,7 @@ export interface components { /** Format: date-time */ completed_at: string | null; /** - * @description The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -40909,6 +41219,8 @@ export interface components { git_tags_url: string; /** Format: uri */ git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; /** * @description Whether downloads are enabled. * @default true @@ -41057,6 +41369,8 @@ export interface components { visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -86178,6 +86492,98 @@ export interface components { url?: string; }; }; + "webhook-user-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + /** User */ + user?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + }; + "webhook-user-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + /** User */ + user?: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; + /** Format: uri */ + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ + organizations_url?: string; + /** Format: uri */ + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + }; /** watch started event */ "webhook-watch-started": { /** @enum {string} */ @@ -88835,7 +89241,7 @@ export interface components { "role-id": number; /** @description The unique identifier of the group. */ "group-id": number; - /** @description The unique identifier of the hook. */ + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The unique identifier of the invitation. */ "invitation-id": number; @@ -88878,6 +89284,27 @@ export interface components { "personal-access-token-after"?: string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The custom property name. The name is case sensitive. */ + "custom-property-name": string; + /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + "repository-name-in-query"?: number; + /** + * @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + */ + "time-period"?: "hour" | "day" | "week" | "month"; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ + "actor-name-in-query"?: string; + /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + "rule-suite-result"?: "pass" | "fail" | "bypass" | "all"; + /** + * @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. + */ + "rule-suite-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ "secret-scanning-pagination-before-org-repo"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/enterprise-cloud@latest//rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ @@ -89022,6 +89449,8 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; + /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ + "ref-in-query"?: string; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -97407,7 +97836,7 @@ export interface operations { * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - "copilot/get-copilot-seat-assignment-details-for-user": { + "copilot/get-copilot-seat-details-for-user": { parameters: { path: { org: components["parameters"]["org"]; @@ -97604,7 +98033,7 @@ export interface operations { * @example true */ org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: "repositories"[]; }; }; @@ -98424,6 +98853,209 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + /** + * Get all custom properties for an organization + * @description Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/get-all-custom-properties": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update custom properties for an organization + * @description Creates new or updates existing custom properties defined for an organization in a batch. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + "orgs/create-or-update-custom-properties": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The array of custom properties to create or update. */ + properties: components["schemas"]["org-custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get a custom property for an organization + * @description Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/get-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update a custom property for an organization + * @description Creates a new or updates an existing custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/create-or-update-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/remove-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List custom property values for organization repositories + * @description Lists organization repositories with all of their custom property values. + * Organization members can read these properties. + */ + "orgs/list-custom-properties-values-for-repos": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update custom property values for organization repositories + * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + "orgs/create-or-update-custom-properties-values-for-repos": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The names of repositories that the custom property values will be applied to. */ + repository_names: string[]; + /** @description List of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. @@ -98789,6 +99421,59 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List organization rule suites + * @description Lists suites of rule evaluations at the organization level. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + "repos/get-org-rule-suites": { + parameters: { + query?: { + repository_name?: components["parameters"]["repository-name-in-query"]; + time_period?: components["parameters"]["time-period"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + rule_suite_result?: components["parameters"]["rule-suite-result"]; + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suites"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get an organization rule suite + * @description Gets information about a suite of rule evaluations from within an organization. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/enterprise-cloud@latest//organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + "repos/get-org-rule-suite": { + parameters: { + path: { + org: components["parameters"]["org"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suite"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. @@ -101676,7 +102361,6 @@ export interface operations { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/re-run-job-for-workflow-run": { @@ -101807,7 +102491,6 @@ export interface operations { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -102055,7 +102738,6 @@ export interface operations { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102092,7 +102774,6 @@ export interface operations { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102117,7 +102798,6 @@ export interface operations { * @description Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102157,7 +102837,6 @@ export interface operations { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -102190,7 +102869,6 @@ export interface operations { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -102222,7 +102900,6 @@ export interface operations { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102248,7 +102925,6 @@ export interface operations { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102272,7 +102948,6 @@ export interface operations { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102295,7 +102970,6 @@ export interface operations { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102326,7 +103000,6 @@ export interface operations { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102358,7 +103031,6 @@ export interface operations { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102384,7 +103056,6 @@ export interface operations { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -102659,7 +103330,6 @@ export interface operations { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/cancel-workflow-run": { @@ -102712,6 +103382,32 @@ export interface operations { }; }; }; + /** + * Force cancel a workflow run + * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/force-cancel-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** @description Response */ + 202: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + 409: components["responses"]["conflict"]; + }; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#parameters). @@ -103103,7 +103799,6 @@ export interface operations { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103138,7 +103833,6 @@ export interface operations { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103173,7 +103867,6 @@ export interface operations { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103199,7 +103892,6 @@ export interface operations { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103223,7 +103915,6 @@ export interface operations { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103449,7 +104140,7 @@ export interface operations { * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * * For more information about viewing repository activity, - * see "[Viewing repository activity](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." + * see "[Viewing activity and data for your repository](https://docs.github.com/enterprise-cloud@latest//repositories/viewing-activity-and-data-for-your-repository)." */ "repos/list-activities": { parameters: { @@ -104987,9 +105678,9 @@ export interface operations { }; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/update": { parameters: { @@ -105274,9 +105965,9 @@ export interface operations { }; /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/list-for-suite": { parameters: { @@ -105780,7 +106471,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; 503: components["responses"]["service_unavailable"]; @@ -106155,6 +106846,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Check if permissions defined by a devcontainer have been accepted by the authenticated user + * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + "codespaces/check-permissions-for-devcontainer": { + parameters: { + query: { + /** @description The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + ref: string; + /** @description Path to the devcontainer.json configuration to use for the permission check. */ + devcontainer_path: string; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response when the permission check is successful */ + 200: { + content: { + "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. @@ -106945,9 +107671,11 @@ export interface operations { }; /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-cloud@latest//rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ "checks/list-for-ref": { parameters: { @@ -106983,9 +107711,9 @@ export interface operations { }; /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ "checks/list-suites-for-ref": { parameters: { @@ -107093,10 +107821,8 @@ export interface operations { * README, and CONTRIBUTING files. * * The `health_percentage` score is defined as a percentage of how many of - * these four documents are present: README, CONTRIBUTING, LICENSE, and - * CODE_OF_CONDUCT. For example, if all four documents are present, then - * the `health_percentage` is `100`. If only one is present, then the - * `health_percentage` is `25`. + * the recommended community health files are present. For more information, see + * "[About community profiles for public repositories](https://docs.github.com/enterprise-cloud@latest//communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." * * `content_reports_enabled` is only returned for organization-owned repositories. */ @@ -108220,6 +108946,7 @@ export interface operations { content: { "application/json": { wait_timer?: components["schemas"]["wait-timer"]; + prevent_self_review?: components["schemas"]["prevent-self-review"]; /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: | { @@ -108305,7 +109032,7 @@ export interface operations { }; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -108319,7 +109046,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; responses: { @@ -108341,7 +109068,7 @@ export interface operations { }; /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ @@ -108365,7 +109092,7 @@ export interface operations { }; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -108394,7 +109121,7 @@ export interface operations { }; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -109589,11 +110316,10 @@ export interface operations { }; /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -109648,8 +110374,12 @@ export interface operations { }; /** * Start an import - * @description Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. + * Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/start-import": { parameters: { @@ -109695,11 +110425,10 @@ export interface operations { }; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/cancel-import": { parameters: { @@ -109718,6 +110447,7 @@ export interface operations { }; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -109725,9 +110455,7 @@ export interface operations { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/update-import": { parameters: { @@ -109769,13 +110497,12 @@ export interface operations { }; /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/get-commit-authors": { parameters: { @@ -109800,12 +110527,11 @@ export interface operations { }; /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/map-commit-author": { parameters: { @@ -109839,11 +110565,10 @@ export interface operations { }; /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/get-large-files": { parameters: { @@ -109864,15 +110589,14 @@ export interface operations { }; /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/set-lfs-preference": { parameters: { @@ -112193,6 +112917,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + /** + * Get all custom property values for a repository + * @description Gets all custom property values that are set for a repository. + * Users with admin access to the repository can use this endpoint. + */ + "repos/get-custom-properties-values": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["custom-property-value"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List pull requests * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/enterprise-cloud@latest//github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -112396,7 +113143,7 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { @@ -114007,6 +114754,61 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List repository rule suites + * @description Lists suites of rule evaluations at the repository level. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + "repos/get-repo-rule-suites": { + parameters: { + query?: { + ref?: components["parameters"]["ref-in-query"]; + time_period?: components["parameters"]["time-period"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + rule_suite_result?: components["parameters"]["rule-suite-result"]; + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suites"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get a repository rule suite + * @description Gets information about a suite of rule evaluations from within a repository. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + "repos/get-repo-rule-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suite"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a repository ruleset * @description Get a ruleset for a repository. @@ -115413,7 +116215,6 @@ export interface operations { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -115448,7 +116249,6 @@ export interface operations { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -115483,7 +116283,6 @@ export interface operations { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -115509,7 +116308,6 @@ export interface operations { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -115533,7 +116331,6 @@ export interface operations { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ diff --git a/packages/openapi-types-ghes-3.10/package.json b/packages/openapi-types-ghes-3.10/package.json index 17a9d3d57..a08f09fc6 100644 --- a/packages/openapi-types-ghes-3.10/package.json +++ b/packages/openapi-types-ghes-3.10/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "13.0.0" + "openapi-version": "13.1.0" } } diff --git a/packages/openapi-types-ghes-3.10/types.d.ts b/packages/openapi-types-ghes-3.10/types.d.ts index 02fc32dc4..f44fc0bbf 100644 --- a/packages/openapi-types-ghes-3.10/types.d.ts +++ b/packages/openapi-types-ghes-3.10/types.d.ts @@ -393,7 +393,7 @@ export interface paths { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.10/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ post: operations["oauth-authorizations/create-authorization"]; }; @@ -2368,6 +2368,8 @@ export interface paths { /** * Start an organization migration * @description Initiates the generation of a migration archive. + * + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.10/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ post: operations["migrations/start-for-org"]; }; @@ -3322,7 +3324,6 @@ export interface paths { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; @@ -3361,7 +3362,6 @@ export interface paths { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3455,7 +3455,6 @@ export interface paths { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3467,7 +3466,6 @@ export interface paths { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3479,7 +3477,6 @@ export interface paths { * @description Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3492,7 +3489,6 @@ export interface paths { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3512,7 +3508,6 @@ export interface paths { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3531,7 +3526,6 @@ export interface paths { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3541,7 +3535,6 @@ export interface paths { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3553,7 +3546,6 @@ export interface paths { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3564,7 +3556,6 @@ export interface paths { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3574,7 +3565,6 @@ export interface paths { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3585,7 +3575,6 @@ export interface paths { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3601,7 +3590,6 @@ export interface paths { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3677,7 +3665,6 @@ export interface paths { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; @@ -3807,7 +3794,6 @@ export interface paths { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3817,7 +3803,6 @@ export interface paths { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3829,7 +3814,6 @@ export interface paths { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3839,7 +3823,6 @@ export interface paths { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3849,7 +3832,6 @@ export interface paths { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -4263,9 +4245,9 @@ export interface paths { get: operations["checks/get"]; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; }; @@ -4315,9 +4297,9 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; }; @@ -4788,18 +4770,20 @@ export interface paths { "/repos/{owner}/{repo}/commits/{ref}/check-runs": { /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; }; @@ -5202,7 +5186,7 @@ export interface paths { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** @@ -6108,7 +6092,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** @@ -6749,7 +6733,6 @@ export interface paths { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6759,7 +6742,6 @@ export interface paths { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6771,7 +6753,6 @@ export interface paths { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6781,7 +6762,6 @@ export interface paths { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6791,7 +6771,6 @@ export interface paths { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -15269,7 +15248,7 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** @example true */ has_discussions: boolean; archived: boolean; @@ -17098,7 +17077,7 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; - /** @description Languages to be analysed. */ + /** @description Languages to be analyzed. */ languages?: ( | "c-cpp" | "csharp" @@ -17135,7 +17114,7 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; - /** @description CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, and `ruby`. */ + /** @description CodeQL languages to be analyzed. */ languages?: ( | "c-cpp" | "csharp" @@ -18444,6 +18423,17 @@ export interface components { */ name?: string; }; + /** Deployment branch and tag policy name pattern */ + "deployment-branch-policy-name-pattern-with-type": { + /** + * @description The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example release/* + */ + name: string; + }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { /** @@ -24530,7 +24520,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: @@ -24841,7 +24831,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -25140,7 +25130,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -25298,7 +25288,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -25430,7 +25420,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -25666,7 +25656,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -27941,7 +27931,7 @@ export interface components { /** Format: date-time */ completed_at: string | null; /** - * @description The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -37435,6 +37425,8 @@ export interface components { git_tags_url: string; /** Format: uri */ git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; /** * @description Whether downloads are enabled. * @default true @@ -37583,6 +37575,8 @@ export interface components { visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -82195,7 +82189,7 @@ export interface components { "per-page"?: number; /** @description Page number of the results to fetch. */ page?: number; - /** @description The unique identifier of the hook. */ + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ direction?: "asc" | "desc"; @@ -84480,7 +84474,7 @@ export interface operations { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.10/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.10/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ "oauth-authorizations/create-authorization": { requestBody?: { @@ -90724,6 +90718,8 @@ export interface operations { /** * Start an organization migration * @description Initiates the generation of a migration archive. + * + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.10/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ "migrations/start-for-org": { parameters: { @@ -90776,7 +90772,7 @@ export interface operations { * @example true */ org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: "repositories"[]; }; }; @@ -94603,7 +94599,6 @@ export interface operations { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/re-run-job-for-workflow-run": { @@ -94734,7 +94729,6 @@ export interface operations { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -94982,7 +94976,6 @@ export interface operations { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95017,7 +95010,6 @@ export interface operations { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95042,7 +95034,6 @@ export interface operations { * @description Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95082,7 +95073,6 @@ export interface operations { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -95115,7 +95105,6 @@ export interface operations { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -95147,7 +95136,6 @@ export interface operations { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95173,7 +95161,6 @@ export interface operations { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95197,7 +95184,6 @@ export interface operations { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95220,7 +95206,6 @@ export interface operations { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95251,7 +95236,6 @@ export interface operations { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95283,7 +95267,6 @@ export interface operations { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95309,7 +95292,6 @@ export interface operations { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -95559,7 +95541,6 @@ export interface operations { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/cancel-workflow-run": { @@ -95980,7 +95961,6 @@ export interface operations { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -96015,7 +95995,6 @@ export interface operations { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -96050,7 +96029,6 @@ export interface operations { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -96076,7 +96054,6 @@ export interface operations { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -96100,7 +96077,6 @@ export interface operations { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -97746,9 +97722,9 @@ export interface operations { }; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/update": { parameters: { @@ -98033,9 +98009,9 @@ export interface operations { }; /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/list-for-suite": { parameters: { @@ -98476,7 +98452,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; 503: components["responses"]["service_unavailable"]; @@ -99273,9 +99249,11 @@ export interface operations { }; /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.10/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ "checks/list-for-ref": { parameters: { @@ -99311,9 +99289,9 @@ export interface operations { }; /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ "checks/list-suites-for-ref": { parameters: { @@ -100615,7 +100593,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; responses: { @@ -100639,7 +100617,7 @@ export interface operations { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ "repos/get-deployment-branch-policy": { parameters: { @@ -104329,7 +104307,7 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.10/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { @@ -106834,7 +106812,6 @@ export interface operations { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -106869,7 +106846,6 @@ export interface operations { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -106904,7 +106880,6 @@ export interface operations { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -106930,7 +106905,6 @@ export interface operations { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -106954,7 +106928,6 @@ export interface operations { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ diff --git a/packages/openapi-types-ghes-3.7/package.json b/packages/openapi-types-ghes-3.7/package.json index c4ec76da3..4862bfe22 100644 --- a/packages/openapi-types-ghes-3.7/package.json +++ b/packages/openapi-types-ghes-3.7/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "13.0.0" + "openapi-version": "13.1.0" } } diff --git a/packages/openapi-types-ghes-3.7/types.d.ts b/packages/openapi-types-ghes-3.7/types.d.ts index 4cb04ea03..f1edb54fa 100644 --- a/packages/openapi-types-ghes-3.7/types.d.ts +++ b/packages/openapi-types-ghes-3.7/types.d.ts @@ -393,7 +393,7 @@ export interface paths { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.7/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.7/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.7/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ post: operations["oauth-authorizations/create-authorization"]; }; @@ -2843,7 +2843,6 @@ export interface paths { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; @@ -2950,7 +2949,6 @@ export interface paths { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2962,7 +2960,6 @@ export interface paths { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2975,7 +2972,6 @@ export interface paths { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -2995,7 +2991,6 @@ export interface paths { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3014,7 +3009,6 @@ export interface paths { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3024,7 +3018,6 @@ export interface paths { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3036,7 +3029,6 @@ export interface paths { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3047,7 +3039,6 @@ export interface paths { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3057,7 +3048,6 @@ export interface paths { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3068,7 +3058,6 @@ export interface paths { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3084,7 +3073,6 @@ export interface paths { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3160,7 +3148,6 @@ export interface paths { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; @@ -3673,9 +3660,9 @@ export interface paths { get: operations["checks/get"]; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; }; @@ -3725,9 +3712,9 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; }; @@ -4182,18 +4169,20 @@ export interface paths { "/repos/{owner}/{repo}/commits/{ref}/check-runs": { /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; }; @@ -4562,7 +4551,7 @@ export interface paths { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** @@ -5423,7 +5412,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** @@ -13460,7 +13449,7 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** @example true */ has_discussions: boolean; archived: boolean; @@ -16304,6 +16293,17 @@ export interface components { */ name?: string; }; + /** Deployment branch and tag policy name pattern */ + "deployment-branch-policy-name-pattern-with-type": { + /** + * @description The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example release/* + */ + name: string; + }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { /** @@ -22316,7 +22316,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: @@ -22627,7 +22627,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -22926,7 +22926,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -23084,7 +23084,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -23216,7 +23216,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -23452,7 +23452,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -25707,7 +25707,7 @@ export interface components { /** Format: date-time */ completed_at: string | null; /** - * @description The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -35179,6 +35179,8 @@ export interface components { git_tags_url: string; /** Format: uri */ git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; /** * @description Whether downloads are enabled. * @default true @@ -35327,6 +35329,8 @@ export interface components { visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -79644,7 +79648,7 @@ export interface components { "per-page"?: number; /** @description Page number of the results to fetch. */ page?: number; - /** @description The unique identifier of the hook. */ + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ direction?: "asc" | "desc"; @@ -81821,7 +81825,7 @@ export interface operations { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.7/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.7/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.7/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ "oauth-authorizations/create-authorization": { requestBody?: { @@ -87155,7 +87159,7 @@ export interface operations { * @example true */ org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: "repositories"[]; }; }; @@ -90401,7 +90405,6 @@ export interface operations { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/re-run-job-for-workflow-run": { @@ -90706,7 +90709,6 @@ export interface operations { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90741,7 +90743,6 @@ export interface operations { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90767,7 +90768,6 @@ export interface operations { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -90800,7 +90800,6 @@ export interface operations { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -90832,7 +90831,6 @@ export interface operations { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90858,7 +90856,6 @@ export interface operations { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90882,7 +90879,6 @@ export interface operations { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90905,7 +90901,6 @@ export interface operations { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90936,7 +90931,6 @@ export interface operations { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90968,7 +90962,6 @@ export interface operations { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -90994,7 +90987,6 @@ export interface operations { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -91244,7 +91236,6 @@ export interface operations { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/cancel-workflow-run": { @@ -93202,9 +93193,9 @@ export interface operations { }; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/update": { parameters: { @@ -93489,9 +93480,9 @@ export interface operations { }; /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/list-for-suite": { parameters: { @@ -94663,9 +94654,11 @@ export interface operations { }; /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.7/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ "checks/list-for-ref": { parameters: { @@ -94701,9 +94694,9 @@ export interface operations { }; /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ "checks/list-suites-for-ref": { parameters: { @@ -95849,7 +95842,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; responses: { @@ -95873,7 +95866,7 @@ export interface operations { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ "repos/get-deployment-branch-policy": { parameters: { @@ -99412,7 +99405,7 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.7/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { diff --git a/packages/openapi-types-ghes-3.8/package.json b/packages/openapi-types-ghes-3.8/package.json index 1e1be3080..79b1ed3f8 100644 --- a/packages/openapi-types-ghes-3.8/package.json +++ b/packages/openapi-types-ghes-3.8/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "13.0.0" + "openapi-version": "13.1.0" } } diff --git a/packages/openapi-types-ghes-3.8/types.d.ts b/packages/openapi-types-ghes-3.8/types.d.ts index 6b2bed6c9..f1bdfcb7c 100644 --- a/packages/openapi-types-ghes-3.8/types.d.ts +++ b/packages/openapi-types-ghes-3.8/types.d.ts @@ -393,7 +393,7 @@ export interface paths { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.8/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ post: operations["oauth-authorizations/create-authorization"]; }; @@ -2227,6 +2227,8 @@ export interface paths { /** * Start an organization migration * @description Initiates the generation of a migration archive. + * + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.8/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ post: operations["migrations/start-for-org"]; }; @@ -3009,7 +3011,6 @@ export interface paths { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; @@ -3118,7 +3119,6 @@ export interface paths { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3130,7 +3130,6 @@ export interface paths { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3143,7 +3142,6 @@ export interface paths { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3163,7 +3161,6 @@ export interface paths { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3182,7 +3179,6 @@ export interface paths { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3192,7 +3188,6 @@ export interface paths { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3204,7 +3199,6 @@ export interface paths { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3215,7 +3209,6 @@ export interface paths { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3225,7 +3218,6 @@ export interface paths { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3236,7 +3228,6 @@ export interface paths { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3252,7 +3243,6 @@ export interface paths { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3328,7 +3318,6 @@ export interface paths { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; @@ -3445,7 +3434,6 @@ export interface paths { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3455,7 +3443,6 @@ export interface paths { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3467,7 +3454,6 @@ export interface paths { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3477,7 +3463,6 @@ export interface paths { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3487,7 +3472,6 @@ export interface paths { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3894,9 +3878,9 @@ export interface paths { get: operations["checks/get"]; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; }; @@ -3946,9 +3930,9 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; }; @@ -4402,18 +4386,20 @@ export interface paths { "/repos/{owner}/{repo}/commits/{ref}/check-runs": { /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; }; @@ -4809,7 +4795,7 @@ export interface paths { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** @@ -5670,7 +5656,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** @@ -6292,7 +6278,6 @@ export interface paths { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6302,7 +6287,6 @@ export interface paths { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6314,7 +6298,6 @@ export interface paths { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6324,7 +6307,6 @@ export interface paths { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6334,7 +6316,6 @@ export interface paths { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -13989,7 +13970,7 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** @example true */ has_discussions: boolean; archived: boolean; @@ -16952,6 +16933,17 @@ export interface components { */ name?: string; }; + /** Deployment branch and tag policy name pattern */ + "deployment-branch-policy-name-pattern-with-type": { + /** + * @description The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example release/* + */ + name: string; + }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { /** @@ -22865,7 +22857,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: @@ -23176,7 +23168,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -23475,7 +23467,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -23633,7 +23625,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -23765,7 +23757,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -24001,7 +23993,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -26256,7 +26248,7 @@ export interface components { /** Format: date-time */ completed_at: string | null; /** - * @description The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -35728,6 +35720,8 @@ export interface components { git_tags_url: string; /** Format: uri */ git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; /** * @description Whether downloads are enabled. * @default true @@ -35876,6 +35870,8 @@ export interface components { visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -80255,7 +80251,7 @@ export interface components { "per-page"?: number; /** @description Page number of the results to fetch. */ page?: number; - /** @description The unique identifier of the hook. */ + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ direction?: "asc" | "desc"; @@ -82497,7 +82493,7 @@ export interface operations { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.8/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.8/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ "oauth-authorizations/create-authorization": { requestBody?: { @@ -88302,6 +88298,8 @@ export interface operations { /** * Start an organization migration * @description Initiates the generation of a migration archive. + * + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.8/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ "migrations/start-for-org": { parameters: { @@ -88354,7 +88352,7 @@ export interface operations { * @example true */ org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: "repositories"[]; }; }; @@ -91615,7 +91613,6 @@ export interface operations { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/re-run-job-for-workflow-run": { @@ -91924,7 +91921,6 @@ export interface operations { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -91959,7 +91955,6 @@ export interface operations { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -91985,7 +91980,6 @@ export interface operations { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -92018,7 +92012,6 @@ export interface operations { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -92050,7 +92043,6 @@ export interface operations { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92076,7 +92068,6 @@ export interface operations { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92100,7 +92091,6 @@ export interface operations { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92123,7 +92113,6 @@ export interface operations { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92154,7 +92143,6 @@ export interface operations { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92186,7 +92174,6 @@ export interface operations { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92212,7 +92199,6 @@ export interface operations { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -92462,7 +92448,6 @@ export interface operations { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/cancel-workflow-run": { @@ -92851,7 +92836,6 @@ export interface operations { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -92886,7 +92870,6 @@ export interface operations { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -92921,7 +92904,6 @@ export interface operations { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -92947,7 +92929,6 @@ export interface operations { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -92971,7 +92952,6 @@ export interface operations { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -94593,9 +94573,9 @@ export interface operations { }; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/update": { parameters: { @@ -94880,9 +94860,9 @@ export interface operations { }; /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/list-for-suite": { parameters: { @@ -96055,9 +96035,11 @@ export interface operations { }; /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.8/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ "checks/list-for-ref": { parameters: { @@ -96093,9 +96075,9 @@ export interface operations { }; /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ "checks/list-suites-for-ref": { parameters: { @@ -97372,7 +97354,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; responses: { @@ -97396,7 +97378,7 @@ export interface operations { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ "repos/get-deployment-branch-policy": { parameters: { @@ -100941,7 +100923,7 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.8/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { @@ -103381,7 +103363,6 @@ export interface operations { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103416,7 +103397,6 @@ export interface operations { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103451,7 +103431,6 @@ export interface operations { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103477,7 +103456,6 @@ export interface operations { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -103501,7 +103479,6 @@ export interface operations { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ diff --git a/packages/openapi-types-ghes-3.9/package.json b/packages/openapi-types-ghes-3.9/package.json index 20a5b06a2..e0b675b28 100644 --- a/packages/openapi-types-ghes-3.9/package.json +++ b/packages/openapi-types-ghes-3.9/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "13.0.0" + "openapi-version": "13.1.0" } } diff --git a/packages/openapi-types-ghes-3.9/types.d.ts b/packages/openapi-types-ghes-3.9/types.d.ts index 7e1012ceb..4fb23b5ac 100644 --- a/packages/openapi-types-ghes-3.9/types.d.ts +++ b/packages/openapi-types-ghes-3.9/types.d.ts @@ -393,7 +393,7 @@ export interface paths { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.9/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ post: operations["oauth-authorizations/create-authorization"]; }; @@ -2326,6 +2326,8 @@ export interface paths { /** * Start an organization migration * @description Initiates the generation of a migration archive. + * + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ post: operations["migrations/start-for-org"]; }; @@ -3204,7 +3206,6 @@ export interface paths { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; @@ -3243,7 +3244,6 @@ export interface paths { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3337,7 +3337,6 @@ export interface paths { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3349,7 +3348,6 @@ export interface paths { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3362,7 +3360,6 @@ export interface paths { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3382,7 +3379,6 @@ export interface paths { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -3401,7 +3397,6 @@ export interface paths { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3411,7 +3406,6 @@ export interface paths { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3423,7 +3417,6 @@ export interface paths { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3434,7 +3427,6 @@ export interface paths { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3444,7 +3436,6 @@ export interface paths { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3455,7 +3446,6 @@ export interface paths { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3471,7 +3461,6 @@ export interface paths { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3547,7 +3536,6 @@ export interface paths { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; @@ -3664,7 +3652,6 @@ export interface paths { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3674,7 +3661,6 @@ export interface paths { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3686,7 +3672,6 @@ export interface paths { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3696,7 +3681,6 @@ export interface paths { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3706,7 +3690,6 @@ export interface paths { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -4113,9 +4096,9 @@ export interface paths { get: operations["checks/get"]; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; }; @@ -4165,9 +4148,9 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; }; @@ -4638,18 +4621,20 @@ export interface paths { "/repos/{owner}/{repo}/commits/{ref}/check-runs": { /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; }; @@ -5052,7 +5037,7 @@ export interface paths { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** @@ -5913,7 +5898,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** @@ -6554,7 +6539,6 @@ export interface paths { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6564,7 +6548,6 @@ export interface paths { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6576,7 +6559,6 @@ export interface paths { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6586,7 +6568,6 @@ export interface paths { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6596,7 +6577,6 @@ export interface paths { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -14908,7 +14888,7 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** @example true */ has_discussions: boolean; archived: boolean; @@ -16703,7 +16683,7 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; - /** @description Languages to be analysed. */ + /** @description Languages to be analyzed. */ languages?: ( | "c-cpp" | "csharp" @@ -18039,6 +18019,17 @@ export interface components { */ name?: string; }; + /** Deployment branch and tag policy name pattern */ + "deployment-branch-policy-name-pattern-with-type": { + /** + * @description The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example release/* + */ + name: string; + }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { /** @@ -23998,7 +23989,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: @@ -24309,7 +24300,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -24608,7 +24599,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -24766,7 +24757,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -24898,7 +24889,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -25134,7 +25125,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -27389,7 +27380,7 @@ export interface components { /** Format: date-time */ completed_at: string | null; /** - * @description The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -36883,6 +36874,8 @@ export interface components { git_tags_url: string; /** Format: uri */ git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; /** * @description Whether downloads are enabled. * @default true @@ -37031,6 +37024,8 @@ export interface components { visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -81487,7 +81482,7 @@ export interface components { "per-page"?: number; /** @description Page number of the results to fetch. */ page?: number; - /** @description The unique identifier of the hook. */ + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ direction?: "asc" | "desc"; @@ -83756,7 +83751,7 @@ export interface operations { * * You can also create tokens on GitHub Enterprise Server from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/creating-an-access-token-for-command-line-use). * - * Organizations that enforce SAML SSO require personal access tokens to be allowed. Read more about allowing tokens in [the GitHub Help documentation](https://docs.github.com/enterprise-server@3.9/articles/about-identity-and-access-management-with-saml-single-sign-on). + * Organizations that enforce SAML SSO require personal access tokens to be allowed. For more information, see "[About identity and access management with SAML single sign-on](https://docs.github.com/enterprise-server@3.9/enterprise-cloud@latest/organizations/managing-saml-single-sign-on-for-your-organization/about-identity-and-access-management-with-saml-single-sign-on)" in the GitHub Enterprise Cloud documentation. */ "oauth-authorizations/create-authorization": { requestBody?: { @@ -89848,6 +89843,8 @@ export interface operations { /** * Start an organization migration * @description Initiates the generation of a migration archive. + * + * Before you can use this endpoint, you must configure a blob storage provider in the "Migrations" section in the Management Console. For more details, see "[Migrating repositories from GitHub Enterprise Server to GitHub Enterprise Cloud](https://docs.github.com/enterprise-server@3.9/migrations/using-github-enterprise-importer/migrating-repositories-with-github-enterprise-importer/migrating-repositories-from-github-enterprise-server-to-github-enterprise-cloud#step-4-set-up-blob-storage)." */ "migrations/start-for-org": { parameters: { @@ -89900,7 +89897,7 @@ export interface operations { * @example true */ org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: "repositories"[]; }; }; @@ -93421,7 +93418,6 @@ export interface operations { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/re-run-job-for-workflow-run": { @@ -93552,7 +93548,6 @@ export interface operations { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -93800,7 +93795,6 @@ export interface operations { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -93835,7 +93829,6 @@ export interface operations { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -93861,7 +93854,6 @@ export interface operations { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -93894,7 +93886,6 @@ export interface operations { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -93926,7 +93917,6 @@ export interface operations { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -93952,7 +93942,6 @@ export interface operations { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -93976,7 +93965,6 @@ export interface operations { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -93999,7 +93987,6 @@ export interface operations { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -94030,7 +94017,6 @@ export interface operations { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -94062,7 +94048,6 @@ export interface operations { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -94088,7 +94073,6 @@ export interface operations { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -94338,7 +94322,6 @@ export interface operations { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/cancel-workflow-run": { @@ -94727,7 +94710,6 @@ export interface operations { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -94762,7 +94744,6 @@ export interface operations { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -94797,7 +94778,6 @@ export interface operations { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -94823,7 +94803,6 @@ export interface operations { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -94847,7 +94826,6 @@ export interface operations { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -96469,9 +96447,9 @@ export interface operations { }; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/update": { parameters: { @@ -96756,9 +96734,9 @@ export interface operations { }; /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/list-for-suite": { parameters: { @@ -97197,7 +97175,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; 503: components["responses"]["service_unavailable"]; @@ -97994,9 +97972,11 @@ export interface operations { }; /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/enterprise-server@3.9/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ "checks/list-for-ref": { parameters: { @@ -98032,9 +98012,9 @@ export interface operations { }; /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ "checks/list-suites-for-ref": { parameters: { @@ -99336,7 +99316,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; responses: { @@ -99360,7 +99340,7 @@ export interface operations { * Get a deployment branch policy * @description Gets a deployment branch policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `administration:read` permission for the repository to use this endpoint. */ "repos/get-deployment-branch-policy": { parameters: { @@ -102905,7 +102885,7 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { @@ -105410,7 +105390,6 @@ export interface operations { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -105445,7 +105424,6 @@ export interface operations { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -105480,7 +105458,6 @@ export interface operations { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -105506,7 +105483,6 @@ export interface operations { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -105530,7 +105506,6 @@ export interface operations { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index 66711fd8a..e69e0f599 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "13.0.0" + "openapi-version": "13.1.0" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index cd583341a..b297ee51a 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -2057,7 +2057,6 @@ export interface paths { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2069,7 +2068,6 @@ export interface paths { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2082,7 +2080,6 @@ export interface paths { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -2102,7 +2099,6 @@ export interface paths { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -2121,7 +2117,6 @@ export interface paths { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2131,7 +2126,6 @@ export interface paths { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2200,11 +2194,21 @@ export interface paths { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + /** + * Force cancel a workflow run + * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + post: operations["actions/force-cancel-workflow-run"]; + }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { /** * List jobs for a workflow run @@ -2687,9 +2691,9 @@ export interface paths { get: operations["checks/get"]; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; }; @@ -2739,9 +2743,9 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; }; @@ -3192,18 +3196,20 @@ export interface paths { "/repos/{owner}/{repo}/commits/{ref}/check-runs": { /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; }; @@ -3507,7 +3513,7 @@ export interface paths { get: operations["repos/list-deployment-branch-policies"]; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -3516,21 +3522,21 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -4347,7 +4353,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** @@ -11390,7 +11396,7 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** @example true */ has_discussions: boolean; archived: boolean; @@ -13887,6 +13893,11 @@ export interface components { id: number; /** @example MDQ6R2F0ZTM3NTU= */ node_id: string; + /** + * @description Whether deployments to this environment can be approved by the user who created the deployment. + * @example false + */ + prevent_self_review?: boolean; /** @example required_reviewers */ type: string; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ @@ -13908,23 +13919,51 @@ export interface components { )[]; deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; }; + /** + * @description Whether or not a user who created the job is prevented from approving their own job. + * @example false + */ + "prevent-self-review": boolean; /** * Deployment branch policy - * @description Details of a deployment branch policy. + * @description Details of a deployment branch or tag policy. */ "deployment-branch-policy": { /** - * @description The unique identifier of the branch policy. + * @description The unique identifier of the branch or tag policy. * @example 361471 */ id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ node_id?: string; /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ name?: string; + /** + * @description Whether this rule targets a branch or tag. + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; + }; + /** Deployment branch and tag policy name pattern */ + "deployment-branch-policy-name-pattern-with-type": { + /** + * @description The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example release/* + */ + name: string; + /** + * @description Whether this rule targets a branch or tag + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { @@ -19340,7 +19379,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: @@ -19651,7 +19690,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -19950,7 +19989,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -20108,7 +20147,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -20240,7 +20279,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -20476,7 +20515,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -22773,7 +22812,7 @@ export interface components { /** Format: date-time */ completed_at: string | null; /** - * @description The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -32236,6 +32275,8 @@ export interface components { git_tags_url: string; /** Format: uri */ git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; /** * @description Whether downloads are enabled. * @default true @@ -32384,6 +32425,8 @@ export interface components { visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -76209,7 +76252,7 @@ export interface components { "per-page"?: number; /** @description Page number of the results to fetch. */ page?: number; - /** @description The unique identifier of the hook. */ + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The direction to sort the results by. */ direction?: "asc" | "desc"; @@ -81647,7 +81690,7 @@ export interface operations { * @example true */ org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: "repositories"[]; }; }; @@ -84510,7 +84553,6 @@ export interface operations { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -84545,7 +84587,6 @@ export interface operations { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -84571,7 +84612,6 @@ export interface operations { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -84604,7 +84644,6 @@ export interface operations { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -84636,7 +84675,6 @@ export interface operations { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -84662,7 +84700,6 @@ export interface operations { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -84891,7 +84928,6 @@ export interface operations { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/cancel-workflow-run": { @@ -84912,6 +84948,32 @@ export interface operations { 409: components["responses"]["conflict"]; }; }; + /** + * Force cancel a workflow run + * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/force-cancel-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** @description Response */ + 202: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + 409: components["responses"]["conflict"]; + }; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters). @@ -86740,9 +86802,9 @@ export interface operations { }; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/update": { parameters: { @@ -87027,9 +87089,9 @@ export interface operations { }; /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/list-for-suite": { parameters: { @@ -88201,9 +88263,11 @@ export interface operations { }; /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ "checks/list-for-ref": { parameters: { @@ -88239,9 +88303,9 @@ export interface operations { }; /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ "checks/list-suites-for-ref": { parameters: { @@ -89090,6 +89154,7 @@ export interface operations { content: { "application/json": { wait_timer?: components["schemas"]["wait-timer"]; + prevent_self_review?: components["schemas"]["prevent-self-review"]; /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: | { @@ -89175,7 +89240,7 @@ export interface operations { }; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -89189,7 +89254,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; responses: { @@ -89211,7 +89276,7 @@ export interface operations { }; /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ @@ -89235,7 +89300,7 @@ export interface operations { }; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -89264,7 +89329,7 @@ export interface operations { }; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -92604,7 +92669,7 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/github-ae@latest/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index 7523a0602..5797863a2 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "13.0.0" + "openapi-version": "13.1.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index c7bb47f9c..9e5d19d6b 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -1760,7 +1760,7 @@ export interface paths { * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - get: operations["copilot/get-copilot-seat-assignment-details-for-user"]; + get: operations["copilot/get-copilot-seat-details-for-user"]; }; "/orgs/{org}/memberships/{username}": { /** @@ -2034,6 +2034,60 @@ export interface paths { */ post: operations["projects/create-for-org"]; }; + "/orgs/{org}/properties/schema": { + /** + * Get all custom properties for an organization + * @description Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-all-custom-properties"]; + /** + * Create or update custom properties for an organization + * @description Creates new or updates existing custom properties defined for an organization in a batch. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties"]; + }; + "/orgs/{org}/properties/schema/{custom_property_name}": { + /** + * Get a custom property for an organization + * @description Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + get: operations["orgs/get-custom-property"]; + /** + * Create or update a custom property for an organization + * @description Creates a new or updates an existing custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + put: operations["orgs/create-or-update-custom-property"]; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + delete: operations["orgs/remove-custom-property"]; + }; + "/orgs/{org}/properties/values": { + /** + * List custom property values for organization repositories + * @description Lists organization repositories with all of their custom property values. + * Organization members can read these properties. + */ + get: operations["orgs/list-custom-properties-values-for-repos"]; + /** + * Create or update custom property values for organization repositories + * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; + }; "/orgs/{org}/public_members": { /** * List public organization members @@ -2093,6 +2147,22 @@ export interface paths { */ post: operations["repos/create-org-ruleset"]; }; + "/orgs/{org}/rulesets/rule-suites": { + /** + * List organization rule suites + * @description Lists suites of rule evaluations at the organization level. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-org-rule-suites"]; + }; + "/orgs/{org}/rulesets/rule-suites/{rule_suite_id}": { + /** + * Get an organization rule suite + * @description Gets information about a suite of rule evaluations from within an organization. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-org-rule-suite"]; + }; "/orgs/{org}/rulesets/{ruleset_id}": { /** * Get an organization repository ruleset @@ -2751,7 +2821,6 @@ export interface paths { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; @@ -2790,7 +2859,6 @@ export interface paths { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -2876,7 +2944,6 @@ export interface paths { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2888,7 +2955,6 @@ export interface paths { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2900,7 +2966,6 @@ export interface paths { * @description Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2913,7 +2978,6 @@ export interface paths { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -2933,7 +2997,6 @@ export interface paths { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -2952,7 +3015,6 @@ export interface paths { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2962,7 +3024,6 @@ export interface paths { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2974,7 +3035,6 @@ export interface paths { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2985,7 +3045,6 @@ export interface paths { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -2995,7 +3054,6 @@ export interface paths { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3006,7 +3064,6 @@ export interface paths { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3022,7 +3079,6 @@ export interface paths { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -3107,7 +3163,6 @@ export interface paths { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; @@ -3125,6 +3180,17 @@ export interface paths { */ post: operations["actions/review-custom-gates-for-run"]; }; + "/repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel": { + /** + * Force cancel a workflow run + * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + post: operations["actions/force-cancel-workflow-run"]; + }; "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { /** * List jobs for a workflow run @@ -3246,7 +3312,6 @@ export interface paths { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3256,7 +3321,6 @@ export interface paths { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3268,7 +3332,6 @@ export interface paths { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3278,7 +3341,6 @@ export interface paths { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3288,7 +3350,6 @@ export interface paths { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -3361,7 +3422,7 @@ export interface paths { * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * * For more information about viewing repository activity, - * see "[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." + * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." */ get: operations["repos/list-activities"]; }; @@ -3731,9 +3792,9 @@ export interface paths { get: operations["checks/get"]; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ patch: operations["checks/update"]; }; @@ -3783,9 +3844,9 @@ export interface paths { "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ get: operations["checks/list-for-suite"]; }; @@ -4105,6 +4166,17 @@ export interface paths { */ get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; }; + "/repos/{owner}/{repo}/codespaces/permissions_check": { + /** + * Check if permissions defined by a devcontainer have been accepted by the authenticated user + * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + get: operations["codespaces/check-permissions-for-devcontainer"]; + }; "/repos/{owner}/{repo}/codespaces/secrets": { /** * List repository secrets @@ -4380,18 +4452,20 @@ export interface paths { "/repos/{owner}/{repo}/commits/{ref}/check-runs": { /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ get: operations["checks/list-for-ref"]; }; "/repos/{owner}/{repo}/commits/{ref}/check-suites": { /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ get: operations["checks/list-suites-for-ref"]; }; @@ -4428,10 +4502,8 @@ export interface paths { * README, and CONTRIBUTING files. * * The `health_percentage` score is defined as a percentage of how many of - * these four documents are present: README, CONTRIBUTING, LICENSE, and - * CODE_OF_CONDUCT. For example, if all four documents are present, then - * the `health_percentage` is `100`. If only one is present, then the - * `health_percentage` is `25`. + * the recommended community health files are present. For more information, see + * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." * * `content_reports_enabled` is only returned for organization-owned repositories. */ @@ -4802,7 +4874,7 @@ export interface paths { get: operations["repos/list-deployment-branch-policies"]; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -4811,21 +4883,21 @@ export interface paths { "/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}": { /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -5194,11 +5266,10 @@ export interface paths { "/repos/{owner}/{repo}/import": { /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -5236,21 +5307,25 @@ export interface paths { get: operations["migrations/get-import-status"]; /** * Start an import - * @description Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ put: operations["migrations/start-import"]; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ delete: operations["migrations/cancel-import"]; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -5258,60 +5333,54 @@ export interface paths { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/update-import"]; }; "/repos/{owner}/{repo}/import/authors": { /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-commit-authors"]; }; "/repos/{owner}/{repo}/import/authors/{author_id}": { /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/map-commit-author"]; }; "/repos/{owner}/{repo}/import/large_files": { /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ get: operations["migrations/get-large-files"]; }; "/repos/{owner}/{repo}/import/lfs": { /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ patch: operations["migrations/set-lfs-preference"]; }; @@ -5805,6 +5874,14 @@ export interface paths { */ post: operations["projects/create-for-repo"]; }; + "/repos/{owner}/{repo}/properties/values": { + /** + * Get all custom property values for a repository + * @description Gets all custom property values that are set for a repository. + * Users with admin access to the repository can use this endpoint. + */ + get: operations["repos/get-custom-properties-values"]; + }; "/repos/{owner}/{repo}/pulls": { /** * List pull requests @@ -5848,7 +5925,7 @@ export interface paths { "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ get: operations["reactions/list-for-pull-request-review-comment"]; /** @@ -6198,6 +6275,22 @@ export interface paths { */ post: operations["repos/create-repo-ruleset"]; }; + "/repos/{owner}/{repo}/rulesets/rule-suites": { + /** + * List repository rule suites + * @description Lists suites of rule evaluations at the repository level. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-repo-rule-suites"]; + }; + "/repos/{owner}/{repo}/rulesets/rule-suites/{rule_suite_id}": { + /** + * Get a repository rule suite + * @description Gets information about a suite of rule evaluations from within a repository. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + get: operations["repos/get-repo-rule-suite"]; + }; "/repos/{owner}/{repo}/rulesets/{ruleset_id}": { /** * Get a repository ruleset @@ -6622,7 +6715,6 @@ export interface paths { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6632,7 +6724,6 @@ export interface paths { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6644,7 +6735,6 @@ export interface paths { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6654,7 +6744,6 @@ export interface paths { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -6664,7 +6753,6 @@ export interface paths { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -12961,6 +13049,11 @@ export interface components { * @enum {string} */ public_code_suggestions: "allow" | "block" | "unconfigured" | "unknown"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. + * @enum {string} + */ + copilot_chat?: "enabled" | "disabled" | "unconfigured"; /** * @description The mode of assigning new seats. * @enum {string} @@ -13151,10 +13244,7 @@ export interface components { * @description Information about a Copilot for Business seat assignment for a user, team, or organization. */ "copilot-seat-details": { - /** - * @description The assignee that has been granted access to GitHub Copilot. - * @enum {object} - */ + /** @description The assignee that has been granted access to GitHub Copilot. */ assignee: { [key: string]: unknown; } & ( @@ -13881,6 +13971,52 @@ export interface components { /** @description Whether or not this project can be seen by everyone. Only present if owner is an organization. */ private?: boolean; }; + /** + * Organization Custom Property + * @description Custom property defined on an organization + */ + "org-custom-property": { + /** @description The name of the property */ + property_name: string; + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + /** + * Custom Property Value + * @description Custom property name and associated value + */ + "custom-property-value": { + /** @description The name of the property */ + property_name: string; + /** @description The value assigned to the property */ + value: string | null; + }; + /** + * Organization Repository Custom Property Values + * @description List of custom property values for a repository + */ + "org-repo-custom-property-values": { + /** @example 1296269 */ + repository_id: number; + /** @example Hello-World */ + repository_name: string; + /** @example octocat/Hello-World */ + repository_full_name: string; + /** @description List of custom property names and associated values */ + properties: components["schemas"]["custom-property-value"][]; + }; /** * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). * @enum {string} @@ -13891,7 +14027,7 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset */ + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ actor_id: number; /** * @description The type of actor that can bypass a ruleset @@ -13983,7 +14119,7 @@ export interface components { }; /** * required_linear_history - * @description Prevent merge commits from being pushed to matching branches. + * @description Prevent merge commits from being pushed to matching refs. */ "repository-rule-required-linear-history": { /** @enum {string} */ @@ -13991,7 +14127,7 @@ export interface components { }; /** * required_deployments - * @description Choose which environments must be successfully deployed to before branches can be merged into a branch that matches this rule. + * @description Choose which environments must be successfully deployed to before refs can be merged into a branch that matches this rule. */ "repository-rule-required-deployments": { /** @enum {string} */ @@ -14003,7 +14139,7 @@ export interface components { }; /** * required_signatures - * @description Commits pushed to matching branches must have verified signatures. + * @description Commits pushed to matching refs must have verified signatures. */ "repository-rule-required-signatures": { /** @enum {string} */ @@ -14041,7 +14177,7 @@ export interface components { }; /** * required_status_checks - * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a branch that matches this rule after status checks have passed. + * @description Choose which status checks must pass before branches can be merged into a branch that matches this rule. When enabled, commits must first be pushed to another branch, then merged or pushed directly to a ref that matches this rule after status checks have passed. */ "repository-rule-required-status-checks": { /** @enum {string} */ @@ -14055,7 +14191,7 @@ export interface components { }; /** * non_fast_forward - * @description Prevent users with push access from force pushing to branches. + * @description Prevent users with push access from force pushing to refs. */ "repository-rule-non-fast-forward": { /** @enum {string} */ @@ -14166,6 +14302,32 @@ export interface components { pattern: string; }; }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + ref?: string; + /** @description The ID of the repository where the workflow is defined */ + repository_id: number; + /** @description The commit SHA of the workflow file to use */ + sha?: string; + }; + /** + * workflows + * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ + "repository-rule-workflows": { + /** @enum {string} */ + type: "workflows"; + parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; /** * Repository Rule * @description A repository rule. @@ -14184,7 +14346,8 @@ export interface components { | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] - | components["schemas"]["repository-rule-tag-name-pattern"]; + | components["schemas"]["repository-rule-tag-name-pattern"] + | components["schemas"]["repository-rule-workflows"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -14235,6 +14398,105 @@ export interface components { /** Format: date-time */ updated_at?: string; }; + /** + * Rule Suites + * @description Response + */ + "rule-suites": { + /** @description The unique identifier of the rule insight. */ + id?: number; + /** @description The number that identifies the user. */ + actor_id?: number; + /** @description The handle for the GitHub user account. */ + actor_name?: string; + /** @description The first commit sha before the push evaluation. */ + before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + repository_name?: string; + /** + * Format: date-time + * @example 2011-01-26T19:06:43Z + */ + pushed_at?: string; + /** + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} + */ + result?: "pass" | "fail" | "bypass"; + /** + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} + */ + evaluation_result?: "pass" | "fail"; + }[]; + /** + * Rule Suite + * @description Response + */ + "rule-suite": { + /** @description The unique identifier of the rule insight. */ + id?: number; + /** @description The number that identifies the user. */ + actor_id?: number; + /** @description The handle for the GitHub user account. */ + actor_name?: string; + /** @description The first commit sha before the push evaluation. */ + before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + repository_name?: string; + /** + * Format: date-time + * @example 2011-01-26T19:06:43Z + */ + pushed_at?: string; + /** + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} + */ + result?: "pass" | "fail" | "bypass"; + /** + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} + */ + evaluation_result?: "pass" | "fail"; + /** @description Details on the evaluated rules. */ + rule_evaluations?: { + rule_source?: { + /** @description The type of rule source. */ + type?: string; + /** @description The ID of the rule source. */ + id?: number | null; + /** @description The name of the rule source. */ + name?: string | null; + }; + /** + * @description The enforcement level of this rule source. + * @enum {string} + */ + enforcement?: "active" | "evaluate" | "deleted ruleset"; + /** + * @description The result of the evaluation of the individual rule. + * @enum {string} + */ + result?: "pass" | "fail"; + /** @description The type of rule. */ + rule_type?: string; + /** @description Any associated details with the rule evaluation. */ + details?: string; + }[]; + }; /** @description A product affected by the vulnerability detailed in a repository security advisory. */ "repository-advisory-vulnerability": { /** @description The name of the package affected by the vulnerability. */ @@ -16056,7 +16318,7 @@ export interface components { has_wiki: boolean; has_pages: boolean; /** @example true */ - has_downloads: boolean; + has_downloads?: boolean; /** @example true */ has_discussions: boolean; archived: boolean; @@ -17992,6 +18254,8 @@ export interface components { * @description The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property. */ url: string; + /** @description The commit SHA of the repository at the time the CodeQL database was created. */ + commit_oid?: string | null; }; /** @description Configuration for code scanning default setup. */ "code-scanning-default-setup": { @@ -18000,7 +18264,7 @@ export interface components { * @enum {string} */ state?: "configured" | "not-configured"; - /** @description Languages to be analysed. */ + /** @description Languages to be analyzed. */ languages?: ( | "c-cpp" | "csharp" @@ -18042,7 +18306,7 @@ export interface components { * @enum {string} */ query_suite?: "default" | "extended"; - /** @description CodeQL languages to be analyzed. Supported values are: `c-cpp`, `csharp`, `go`, `java-kotlin`, `javascript-typescript`, `python`, `ruby`, and `swift`. */ + /** @description CodeQL languages to be analyzed. */ languages?: ( | "c-cpp" | "csharp" @@ -18176,6 +18440,17 @@ export interface components { */ prebuild_availability: "none" | "ready" | "in_progress" | null; }; + /** + * Codespaces Permissions Check + * @description Permission check result for a given devcontainer config. + */ + "codespaces-permissions-check-for-devcontainer": { + /** + * @description Whether the user has accepted the permissions defined by the devcontainer config + * @example true + */ + accepted: boolean; + }; /** * Codespaces Secret * @description Set repository secrets for GitHub Codespaces. @@ -19460,6 +19735,11 @@ export interface components { id: number; /** @example MDQ6R2F0ZTM3NTU= */ node_id: string; + /** + * @description Whether deployments to this environment can be approved by the user who created the deployment. + * @example false + */ + prevent_self_review?: boolean; /** @example required_reviewers */ type: string; /** @description The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ @@ -19481,23 +19761,51 @@ export interface components { )[]; deployment_branch_policy?: components["schemas"]["deployment-branch-policy-settings"]; }; + /** + * @description Whether or not a user who created the job is prevented from approving their own job. + * @example false + */ + "prevent-self-review": boolean; /** * Deployment branch policy - * @description Details of a deployment branch policy. + * @description Details of a deployment branch or tag policy. */ "deployment-branch-policy": { /** - * @description The unique identifier of the branch policy. + * @description The unique identifier of the branch or tag policy. * @example 361471 */ id?: number; /** @example MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE= */ node_id?: string; /** - * @description The name pattern that branches must match in order to deploy to the environment. + * @description The name pattern that branches or tags must match in order to deploy to the environment. * @example release/* */ name?: string; + /** + * @description Whether this rule targets a branch or tag. + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; + }; + /** Deployment branch and tag policy name pattern */ + "deployment-branch-policy-name-pattern-with-type": { + /** + * @description The name pattern that branches or tags must match in order to deploy to the environment. + * + * Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*\/*`. + * For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch). + * @example release/* + */ + name: string; + /** + * @description Whether this rule targets a branch or tag + * @example branch + * @enum {string} + */ + type?: "branch" | "tag"; }; /** Deployment branch policy name pattern */ "deployment-branch-policy-name-pattern": { @@ -22127,6 +22435,8 @@ export interface components { | (components["schemas"]["repository-rule-branch-name-pattern"] & components["schemas"]["repository-rule-ruleset-info"]) | (components["schemas"]["repository-rule-tag-name-pattern"] & + components["schemas"]["repository-rule-ruleset-info"]) + | (components["schemas"]["repository-rule-workflows"] & components["schemas"]["repository-rule-ruleset-info"]); "secret-scanning-alert": { number?: components["schemas"]["alert-number"]; @@ -25719,7 +26029,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. * @enum {string|null} */ conclusion: @@ -26030,7 +26340,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -26329,7 +26639,7 @@ export interface components { /** Format: uri */ check_runs_url: string; /** - * @description The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`,` neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -26487,7 +26797,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -26619,7 +26929,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -26855,7 +27165,7 @@ export interface components { url?: string; } | null; /** - * @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. + * @description The reason for dismissing or closing the alert. * @enum {string|null} */ dismissed_reason: @@ -29152,7 +29462,7 @@ export interface components { /** Format: date-time */ completed_at: string | null; /** - * @description The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has completed. + * @description The result of the completed check run. This value will be `null` until the check run has completed. * @enum {string|null} */ conclusion: @@ -38637,6 +38947,8 @@ export interface components { git_tags_url: string; /** Format: uri */ git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; /** * @description Whether downloads are enabled. * @default true @@ -38785,6 +39097,8 @@ export interface components { visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -86458,7 +86772,7 @@ export interface components { "tool-name"?: components["schemas"]["code-scanning-analysis-tool-name"]; /** @description The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. */ "tool-guid"?: components["schemas"]["code-scanning-analysis-tool-guid"]; - /** @description The unique identifier of the hook. */ + /** @description The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery. */ "hook-id": number; /** @description The unique identifier of the invitation. */ "invitation-id": number; @@ -86501,6 +86815,27 @@ export interface components { "personal-access-token-after"?: string; /** @description The unique identifier of the fine-grained personal access token. */ "fine-grained-personal-access-token-id": number; + /** @description The custom property name. The name is case sensitive. */ + "custom-property-name": string; + /** @description The name of the repository to filter on. When specified, only rule evaluations from this repository will be returned. */ + "repository-name-in-query"?: number; + /** + * @description The time period to filter by. + * + * For example, `day` will filter for rule suites that occurred in the past 24 hours, and `week` will filter for insights that occurred in the past 7 days (168 hours). + */ + "time-period"?: "hour" | "day" | "week" | "month"; + /** @description The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. */ + "actor-name-in-query"?: string; + /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ + "rule-suite-result"?: "pass" | "fail" | "bypass" | "all"; + /** + * @description The unique identifier of the rule suite result. + * To get this ID, you can use [GET /repos/{owner}/{repo}/rulesets/rule-suites](https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites) + * for repositories and [GET /orgs/{org}/rulesets/rule-suites](https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites) + * for organizations. + */ + "rule-suite-id": number; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ "secret-scanning-pagination-before-org-repo"?: string; /** @description A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for events after this cursor. To receive an initial cursor on your first request, include an empty "after" query string. */ @@ -86645,6 +86980,8 @@ export interface components { "asset-id": number; /** @description The unique identifier of the release. */ "release-id": number; + /** @description The name of the ref. Cannot contain wildcard characters. When specified, only rule evaluations triggered for this ref will be returned. */ + "ref-in-query"?: string; /** @description The unique identifier of the tag protection. */ "tag-protection-id": number; /** @description The time frame to display results for. */ @@ -92741,7 +93078,7 @@ export interface operations { * * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. */ - "copilot/get-copilot-seat-assignment-details-for-user": { + "copilot/get-copilot-seat-details-for-user": { parameters: { path: { org: components["parameters"]["org"]; @@ -92938,7 +93275,7 @@ export interface operations { * @example true */ org_metadata_only?: boolean; - /** @description Exclude related items from being returned in the response in order to improve performance of the request. The array can include any of: `"repositories"`. */ + /** @description Exclude related items from being returned in the response in order to improve performance of the request. */ exclude?: "repositories"[]; }; }; @@ -93758,6 +94095,209 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + /** + * Get all custom properties for an organization + * @description Gets all custom properties defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/get-all-custom-properties": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update custom properties for an organization + * @description Creates new or updates existing custom properties defined for an organization in a batch. + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + "orgs/create-or-update-custom-properties": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The array of custom properties to create or update. */ + properties: components["schemas"]["org-custom-property"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Get a custom property for an organization + * @description Gets a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/get-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update a custom property for an organization + * @description Creates a new or updates an existing custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/create-or-update-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** + * @description The type of the value for the property + * @example single_select + * @enum {string} + */ + value_type: "string" | "single_select"; + /** @description Whether the property is required. */ + required?: boolean; + /** @description Default value of the property */ + default_value?: string | null; + /** @description Short description of the property */ + description?: string | null; + /** @description Ordered list of allowed values of the property */ + allowed_values?: string[] | null; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-custom-property"]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Remove a custom property for an organization + * @description Removes a custom property that is defined for an organization. + * You must be an organization owner to use this endpoint. + */ + "orgs/remove-custom-property": { + parameters: { + path: { + org: components["parameters"]["org"]; + custom_property_name: components["parameters"]["custom-property-name"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * List custom property values for organization repositories + * @description Lists organization repositories with all of their custom property values. + * Organization members can read these properties. + */ + "orgs/list-custom-properties-values-for-repos": { + parameters: { + query?: { + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + }; + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; + /** + * Create or update custom property values for organization repositories + * @description Create new or update existing custom property values for repositories in a batch that belong to an organization. + * Each target repository will have its custom property values updated to match the values provided in the request. + * + * A maximum of 30 repositories can be updated in a single request. + * + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Only organization owners (or users with the proper permissions granted by them) can update these properties + */ + "orgs/create-or-update-custom-properties-values-for-repos": { + parameters: { + path: { + org: components["parameters"]["org"]; + }; + }; + requestBody: { + content: { + "application/json": { + /** @description The names of repositories that the custom property values will be applied to. */ + repository_names: string[]; + /** @description List of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["org-repo-custom-property-values"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List public organization members * @description Members of an organization can choose to have their membership publicized or not. @@ -94101,6 +94641,59 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List organization rule suites + * @description Lists suites of rule evaluations at the organization level. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + "repos/get-org-rule-suites": { + parameters: { + query?: { + repository_name?: components["parameters"]["repository-name-in-query"]; + time_period?: components["parameters"]["time-period"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + rule_suite_result?: components["parameters"]["rule-suite-result"]; + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + org: components["parameters"]["org"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suites"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get an organization rule suite + * @description Gets information about a suite of rule evaluations from within an organization. + * For more information, see "[Managing rulesets for repositories in your organization](https://docs.github.com/organizations/managing-organization-settings/managing-rulesets-for-repositories-in-your-organization#viewing-insights-for-rulesets)." + */ + "repos/get-org-rule-suite": { + parameters: { + path: { + org: components["parameters"]["org"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suite"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get an organization repository ruleset * @description Get a repository ruleset for an organization. @@ -96790,7 +97383,6 @@ export interface operations { * @description Re-run a job and its dependent jobs in a workflow run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/re-run-job-for-workflow-run": { @@ -96921,7 +97513,6 @@ export interface operations { * @description Lists all organiation variables shared with a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -97161,7 +97752,6 @@ export interface operations { * @description Lists all self-hosted runners configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97198,7 +97788,6 @@ export interface operations { * @description Lists binaries for the runner application that you can download and run. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97223,7 +97812,6 @@ export interface operations { * @description Generates a configuration that can be passed to the runner application at startup. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97263,7 +97851,6 @@ export interface operations { * expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -97296,7 +97883,6 @@ export interface operations { * a repository. The token expires after one hour. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. * @@ -97328,7 +97914,6 @@ export interface operations { * @description Gets a specific self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97354,7 +97939,6 @@ export interface operations { * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97378,7 +97962,6 @@ export interface operations { * @description Lists all labels for a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97401,7 +97984,6 @@ export interface operations { * self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97432,7 +98014,6 @@ export interface operations { * @description Add custom labels to a self-hosted runner configured in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97464,7 +98045,6 @@ export interface operations { * repository. Returns the remaining read-only labels from the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97490,7 +98070,6 @@ export interface operations { * present on the runner. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. */ @@ -97765,7 +98344,6 @@ export interface operations { * @description Cancels a workflow run using its `id`. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions:write` permission to use this endpoint. */ "actions/cancel-workflow-run": { @@ -97818,6 +98396,32 @@ export interface operations { }; }; }; + /** + * Force cancel a workflow run + * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. + * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). + * + * You must authenticate using an access token with the `repo` scope to use this endpoint. + * GitHub Apps must have the `actions:write` permission to use this endpoint. + */ + "actions/force-cancel-workflow-run": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + run_id: components["parameters"]["run-id"]; + }; + }; + responses: { + /** @description Response */ + 202: { + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + 409: components["responses"]["conflict"]; + }; + }; /** * List jobs for a workflow run * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). @@ -98209,7 +98813,6 @@ export interface operations { * List repository variables * @description Lists all repository variables. * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -98244,7 +98847,6 @@ export interface operations { * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -98279,7 +98881,6 @@ export interface operations { * @description Gets a specific variable in a repository. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -98305,7 +98906,6 @@ export interface operations { * @description Deletes a repository variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -98329,7 +98929,6 @@ export interface operations { * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -98555,7 +99154,7 @@ export interface operations { * @description Lists a detailed history of changes to a repository, such as pushes, merges, force pushes, and branch changes, and associates these changes with commits and users. * * For more information about viewing repository activity, - * see "[Viewing repository activity](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/viewing-repository-activity)." + * see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." */ "repos/list-activities": { parameters: { @@ -100093,9 +100692,9 @@ export interface operations { }; /** * Update a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. * - * Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/update": { parameters: { @@ -100380,9 +100979,9 @@ export interface operations { }; /** * List check runs in a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. * - * Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ "checks/list-for-suite": { parameters: { @@ -100884,7 +101483,7 @@ export interface operations { "application/json": components["schemas"]["code-scanning-default-setup-update-response"]; }; }; - 403: components["responses"]["code_scanning_forbidden_read"]; + 403: components["responses"]["code_scanning_forbidden_write"]; 404: components["responses"]["not_found"]; 409: components["responses"]["code_scanning_conflict"]; 503: components["responses"]["service_unavailable"]; @@ -101259,6 +101858,41 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * Check if permissions defined by a devcontainer have been accepted by the authenticated user + * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. + * + * You must authenticate using an access token with the `codespace` scope to use this endpoint. + * + * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + */ + "codespaces/check-permissions-for-devcontainer": { + parameters: { + query: { + /** @description The git reference that points to the location of the devcontainer configuration to use for the permission check. The value of `ref` will typically be a branch name (`heads/BRANCH_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ + ref: string; + /** @description Path to the devcontainer.json configuration to use for the permission check. */ + devcontainer_path: string; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response when the permission check is successful */ + 200: { + content: { + "application/json": components["schemas"]["codespaces-permissions-check-for-devcontainer"]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + 503: components["responses"]["service_unavailable"]; + }; + }; /** * List repository secrets * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. @@ -102049,9 +102683,11 @@ export interface operations { }; /** * List check runs for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * - * Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. */ "checks/list-for-ref": { parameters: { @@ -102087,9 +102723,9 @@ export interface operations { }; /** * List check suites for a Git reference - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. * - * Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. */ "checks/list-suites-for-ref": { parameters: { @@ -102197,10 +102833,8 @@ export interface operations { * README, and CONTRIBUTING files. * * The `health_percentage` score is defined as a percentage of how many of - * these four documents are present: README, CONTRIBUTING, LICENSE, and - * CODE_OF_CONDUCT. For example, if all four documents are present, then - * the `health_percentage` is `100`. If only one is present, then the - * `health_percentage` is `25`. + * the recommended community health files are present. For more information, see + * "[About community profiles for public repositories](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/about-community-profiles-for-public-repositories)." * * `content_reports_enabled` is only returned for organization-owned repositories. */ @@ -103324,6 +103958,7 @@ export interface operations { content: { "application/json": { wait_timer?: components["schemas"]["wait-timer"]; + prevent_self_review?: components["schemas"]["prevent-self-review"]; /** @description The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed. */ reviewers?: | { @@ -103409,7 +104044,7 @@ export interface operations { }; /** * Create a deployment branch policy - * @description Creates a deployment branch policy for an environment. + * @description Creates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -103423,7 +104058,7 @@ export interface operations { }; requestBody: { content: { - "application/json": components["schemas"]["deployment-branch-policy-name-pattern"]; + "application/json": components["schemas"]["deployment-branch-policy-name-pattern-with-type"]; }; }; responses: { @@ -103445,7 +104080,7 @@ export interface operations { }; /** * Get a deployment branch policy - * @description Gets a deployment branch policy for an environment. + * @description Gets a deployment branch or tag policy for an environment. * * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. */ @@ -103469,7 +104104,7 @@ export interface operations { }; /** * Update a deployment branch policy - * @description Updates a deployment branch policy for an environment. + * @description Updates a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -103498,7 +104133,7 @@ export interface operations { }; /** * Delete a deployment branch policy - * @description Deletes a deployment branch policy for an environment. + * @description Deletes a deployment branch or tag policy for an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. */ @@ -104693,11 +105328,10 @@ export interface operations { }; /** * Get an import status + * @deprecated * @description View the progress of an import. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). * * **Import status** * @@ -104752,8 +105386,12 @@ export interface operations { }; /** * Start an import - * @description Start a source import to a GitHub repository using GitHub Importer. Importing into a GitHub repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response. - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * @deprecated + * @description Start a source import to a GitHub repository using GitHub Importer. + * Importing into a GitHub repository with GitHub Actions enabled is not supported and will + * return a status `422 Unprocessable Entity` response. + * + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/start-import": { parameters: { @@ -104799,11 +105437,10 @@ export interface operations { }; /** * Cancel an import + * @deprecated * @description Stop an import for a repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/cancel-import": { parameters: { @@ -104822,6 +105459,7 @@ export interface operations { }; /** * Update an import + * @deprecated * @description An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API * request. If no parameters are provided, the import will be restarted. * @@ -104829,9 +105467,7 @@ export interface operations { * have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. * You can select the project to import by providing one of the objects in the `project_choices` array in the update request. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/update-import": { parameters: { @@ -104873,13 +105509,12 @@ export interface operations { }; /** * Get commit authors + * @deprecated * @description Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * * This endpoint and the [Map a commit author](https://docs.github.com/rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/get-commit-authors": { parameters: { @@ -104904,12 +105539,11 @@ export interface operations { }; /** * Map a commit author + * @deprecated * @description Update an author's identity for the import. Your application can continue updating authors any time before you push * new commits to the repository. * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/map-commit-author": { parameters: { @@ -104943,11 +105577,10 @@ export interface operations { }; /** * Get large files + * @deprecated * @description List files larger than 100MB found during the import * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/get-large-files": { parameters: { @@ -104968,15 +105601,14 @@ export interface operations { }; /** * Update Git LFS preference + * @deprecated * @description You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability * is powered by [Git LFS](https://git-lfs.com). * * You can learn more about our LFS feature and working with large files [on our help * site](https://docs.github.com/repositories/working-with-files/managing-large-files). * - * **Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end - * on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update - * these docs to reflect relevant changes to the API and will contact all integrators using the "Source imports" API. + * **Warning:** Due to very low levels of usage and available alternatives, this endpoint is deprecated and will no longer be available from 00:00 UTC on April 12, 2024. For more details and alternatives, see the [changelog](https://gh.io/source-imports-api-deprecation). */ "migrations/set-lfs-preference": { parameters: { @@ -107252,6 +107884,29 @@ export interface operations { 422: components["responses"]["validation_failed_simple"]; }; }; + /** + * Get all custom property values for a repository + * @description Gets all custom property values that are set for a repository. + * Users with admin access to the repository can use this endpoint. + */ + "repos/get-custom-properties-values": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["custom-property-value"][]; + }; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + }; + }; /** * List pull requests * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. @@ -107455,7 +108110,7 @@ export interface operations { }; /** * List reactions for a pull request review comment - * @description List the reactions to a [pull request review comment](https://docs.github.com/pulls/comments#get-a-review-comment-for-a-pull-request). + * @description List the reactions to a [pull request review comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request). */ "reactions/list-for-pull-request-review-comment": { parameters: { @@ -109066,6 +109721,61 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + /** + * List repository rule suites + * @description Lists suites of rule evaluations at the repository level. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + "repos/get-repo-rule-suites": { + parameters: { + query?: { + ref?: components["parameters"]["ref-in-query"]; + time_period?: components["parameters"]["time-period"]; + actor_name?: components["parameters"]["actor-name-in-query"]; + rule_suite_result?: components["parameters"]["rule-suite-result"]; + per_page?: components["parameters"]["per-page"]; + page?: components["parameters"]["page"]; + }; + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suites"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; + /** + * Get a repository rule suite + * @description Gets information about a suite of rule evaluations from within a repository. + * For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." + */ + "repos/get-repo-rule-suite": { + parameters: { + path: { + owner: components["parameters"]["owner"]; + repo: components["parameters"]["repo"]; + rule_suite_id: components["parameters"]["rule-suite-id"]; + }; + }; + responses: { + /** @description Response */ + 200: { + content: { + "application/json": components["schemas"]["rule-suite"]; + }; + }; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; /** * Get a repository ruleset * @description Get a ruleset for a repository. @@ -110472,7 +111182,6 @@ export interface operations { * @description Lists all environment variables. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -110507,7 +111216,6 @@ export interface operations { * @description Create an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -110542,7 +111250,6 @@ export interface operations { * @description Gets a specific variable in an environment. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environments:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -110568,7 +111275,6 @@ export interface operations { * @description Deletes an environment variable using the variable name. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */ @@ -110592,7 +111298,6 @@ export interface operations { * @description Updates an environment variable that you can reference in a GitHub Actions workflow. * * You must authenticate using an access token with the `repo` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. * GitHub Apps must have the `environment:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. */